一句话说明
Wiki-Framework（维基框架）是面向 Java 开发者的开源工具库与 Spring Boot / Spring Cloud 组件集，用来加快常用能力封装与微服务脚手架搭建。本页承接安装、模块说明与贡献；公司与产品矩阵见 往南飞科技门户。
| 项 | 说明 |
|---|---|
| 适合谁 | 需要 Utils / 数据源 / Redis / 消息等可复用模块的 Java 团队 |
| 运行时 | JDK17+（1.0.8 起）；JDK8 请用 1.0.7 及以下（不再更新） |
| 协议 | MulanPSL2 |
| 边界 | 组件库 ≠ 完整业务系统；版本与依赖以 Maven Central / 仓库为准 |
介绍
Wiki-Framework 为开发者而生：通过实用工具类与可按需引入的模块，帮助更快搭建 Spring Boot / Spring Cloud 项目。封装覆盖字符串、数字、集合、编码、日期、文件、IO、加解密、JDBC、JSON、HTTP、TCP（WebSocket、Socket）等常见场景。
Wiki 理念
Wiki-Framework 既是工具集，也是学习向知识库；多数工具类来自整理与封装：
- 你可以引入使用，也可以拷贝和修改使用，不必标注来源；请及时反馈 bug。
- 我们重视详细的中文注释，方便源码学习。
- 欢迎开源贡献；若项目对你有用，请 star。
软件架构
在工具类之外，还整合 JWT、Redis、EasyExcel/EasyPOI、MongoDB（Spring Boot）、WebSocket（Netty）、拼音、OpenAPI/Swagger、对象存储与短信客户端、Jackson、ZXing、MQTT、Kryo、CXF、GZIP、HTTP 等常见能力（以当前模块与依赖为准）。
包含组件
一个Java基础工具类，对文件、流、加密解密、转码、正则、线程、XML等JDK方法进行封装，组成各种Utils工具类，同时提供以下组件：
| 模块 | 介绍 |
|---|---|
| wiki-pom | 核心包装模块，提供项目工程所有包含的依赖包的版本的控制 |
| wiki-all | 核心启动模块，提供项目工程启动的必要包项目，只需要引入wiki-all模块即可；所在项目在启动类添加注解 @EnableAutoWiki |
| wiki-core | 核心工具模块，提供项目工程启动的必要配置，公共请求响应拦截器（实现参数 AES 加解密处理），公共异常捕获与处理 |
| wiki-util | 工具库提供了基于HttpUrlConnection的Http，Https客户端封装、脚本执行封装，例如Javascript、 JSON实现（基于 alibaba fastjson）、 针对EsayExcel中Excel的封装、JSON Web Token (JWT)封装实现、异常工具封装、文件的读写、MD5，Base64,Aes,Des,Rsa,Unicode,国密等加解密工具、日志输出的封装（基于log4j）、APP消息推送（支持Uni，腾讯，极光）、电子邮件、常用正则、16进制转换、实体拷贝、时间工具、反序列化工具、字符串工具（空，非空判断以及常用字符） |
| wiki-constant | 常量工具模块，提供项目运行所需的一些常用常量及枚举，例如：缓存、日志、错误码、返回码、缓存的Key、常用正则表达示 |
| wiki-entity | 实体工具模块，提供项目运行所需一些实体类，例如：分页参数，分页结果，返回结果，错误码，返回码以及实体基类（BaseVo, BaseDto, BaseEntity） |
| wiki-datasource | 数据库工具模块（MyBatis），提供数据库连接池，数据源，分页插件，数据库操作工具类 |
| wiki-datasource-jpa | 数据库工具模块（JPA），提供数据库连接池，数据源，分页插件，数据库操作工具类，Repository接口 |
| wiki-datasource-mongodb | 数据库工具模块（Mongodb），提供数据库连接池，数据源，分页插件，数据库操作工具类，Repository接口 |
| wiki-datasource-rw | 数据库工具模块（MyBatis）【主要用于读写分离】，提供数据库连接池，数据源，分页插件，数据库操作工具类； |
| wiki-redis | Redis工具模块，提供Redis连接池，Redis操作工具类，例如：缓存，分布式锁，发布订阅，订阅消息（发布的消息订阅、KEY过期订阅） |
| wiki-kafka | Kafka工具模块，提供Kafka连接池，Kafka操作工具类，例如：发送消息 |
| wiki-kafka-client | Kafka客户端模块，提供Kafka连接池，Kafka操作工具类，例如：监听消息 |
| wiki-mqtt | Mqtt工具模块，提供Mqtt连接池，Mqtt操作工具类，例如：发送消息 |
| wiki-mqtt-client | Mqtt客户端模块，提供Mqtt连接池，Mqtt操作工具类，例如：监听消息 |
| wiki-socket | Socket服务端模块，提供Socket连接池，Socket操作工具类，监听消息接口（需要自行实现），例如：发送消息、接收消息 |
| wiki-socket-client | Socket客户端模块，提供Socket连接池，Socket操作工具类，监听消息接口（需要自行实现），例如：发送消息、接收消息 |
| wiki-sse | SSE服务端模块，提供SSE连接池，SSE操作工具类，监听消息接口（需要自行实现），例如：发送消息、接收消息 |
| wiki-web-socket | WebSocket服务端模块，提供WebSocket连接池，WebSocket操作工具类，监听消息接口（需要自行实现），例如：发送消息、接收消息 |
| wiki-web-socket-client | WebSocket客户端模块，提供WebSocket连接池，WebSocket操作工具类，监听消息接口（需要自行实现），例如：发送消息、接收消息 |
| wiki-log | 日志工具模块，通过AOP切面记录日志（提供controller，mapper，repository切面），例如：记录日志（只限controller层）、参数注入（支持mapper，repository切面）【通过配置参数实现】 |
| wiki-minio | MinIO工具模块，提供MinIO连接池，MinIO操作工具类，例如：上传文件、下载文件、删除文件、文件是否存在、文件列表 |
| wiki-security | Spring Security工具模块，提供Spring Security连接池，Spring Security操作工具类，例如：用户认证、用户授权、用户权限、用户登出、验证码、刷新token、票据生成、票据验证、二维码扫码登录。 |
| wiki-config | Spring Cloud Config配置中心读取模块，提供Spring Cloud Config配置中心读取工具类，例如：自动读取配置文件 |
| wiki-message | 短信消息模块，提供阿里云短信消息工具类，例如：发送短信、拨打电话（已无法申请） |
| wiki-cloud | Spring Cloud工具模块，提供例如：服务注册、服务发现、服务调用、服务配置、服务熔断、服务限流、服务降级 |
| wiki-center | 项目中心模块，提供项目通过数据库（MySQL、PostgreSQL）生成代码，例如：生成实体类（Vo，Dto，Entity）、生成Controller、生成Service、生成ServiceImpl、生成Repository（JPA）、生成Mapper、生成Mapper.xml |
| wiki-license | License工具模块，提供License工具类，例如：生成License、验证License |
| wiki-license-core | License核心模块 |
| wiki-license-verify | License验证模块、提供License验证工具类，例如：验证License |
| wiki-swagger | Swagger工具模块，提供Swagger连接池，Swagger操作工具类，例如：生成Swagger文档【使用的是openapi】 |
| wiki-web | 功能测试模块 |
可以根据需求对每个模块单独引入（建议引用 wiki-pom 控制三方包版本，避免冲突），也可以通过引入 wiki-all 方式引入所有模块。
安装文档
安装教程
无需单独安装发行包：通过 Maven / Gradle 坐标引入即可。
使用说明
- 使用已发布到 Maven Central 的坐标（或自行 deploy 到私有仓）
- 在业务项目中按需引用模块
Maven
在项目最外层POM文件引入：
<parent>
<groupId>com.framewiki</groupId>
<artifactId>wiki-all</artifactId>
<version>1.1.1</version>
</parent>
Gradle
implementation 'com.framewiki:wiki-all:1.1.1'
下载 jar
点击以下链接，下载wiki-all-X.X.X.jar即可
注意 wiki-framework 1.0.8 开始只支持JDK17+，对Android平台没有测试，不能保证所有工具类或工具方法可用。 如果你的项目使用JDK8，请使用 wiki-framework 1.0.7及以下版本（不再更新）
编译安装
访问 wiki-framework 的Gitee主页：https://gitee.com/cdkjframework/wiki-framework 下载整个项目源码（master或1.1.1分支都可）然后进入wiki-framework项目目录执行：
./wiki.sh install然后就可以使用Maven引入了。
示例项目
添砖加瓦
分支说明
Wiki-Framework的源码分为两个分支，功能如下：
| 分支 | 作用 |
|---|---|
| master | 主分支，release版本使用的分支，与中央库提交的jar一致，不接收任何pr或修改 |
| dev | 开发分支，默认为下个版本的SNAPSHOT版本，接受修改或pr |
提供bug反馈或建议
提交问题反馈请说明正在使用的 JDK 版本、Wiki-Framework 版本和相关依赖库版本。
- QQ ①群： 25056933
- 公众号：维基框架 （framewiki-com）
- 电子邮件：wiki@framewiki.com
- Gitee issue
- Github issue
贡献代码的步骤
- 在Gitee或者Github上fork项目到自己的repo
- 把fork过去的项目也就是你的项目clone到你的本地
- 修改代码（记得一定要修改dev分支）
- commit后push到自己的库（dev分支）
- 登录Gitee或Github在你首页可以看到一个 pull request 按钮，点击它，填写一些说明信息，然后提交即可。
- 等待维护者合并
PR遵照的原则
Wiki-Framework欢迎任何人为Wiki-Framework添砖加瓦，贡献代码，不过维护者是一个强迫症患者，为了照顾病人，需要提交的pr（pull request）符合一些规范，规范如下：
- 注释完备，尤其每个新增的方法应按照Java文档规范标明方法说明、参数说明、返回值说明等信息，必要时请添加单元测试，如果愿意，也可以加上你的大名。
- Wiki-Framework的缩进按照IDEA默认缩进，所以请遵守。
- 新加的方法不要使用第三方库的方法，Wiki-Framework遵循无依赖原则（除非在extra模块中加方法工具）。
- 请pull request到
dev分支。master是主分支，表示已经发布中央库的版本，这个分支不允许pr，也不允许修改。 - 我们如果关闭了你的issue或pr，请不要诧异，这是我们保持问题处理整洁的一种方式，你依旧可以继续讨论，当有讨论结果时我们会重新打开。
常见问题
Wiki-Framework 适合做什么？
适合作为 Spring Boot / Spring Cloud 项目的工具与中间件封装层，减少重复造轮子。不替代具体业务系统或行业产品。
和门户上的产品是什么关系？
wangnanfei.cn 是公司产品与选型入口；本站是开源组件文档站。WikiSCRM、MECS、WIKI 本地知识库等产品说明以门户为准。
如何反馈问题？
提交 Gitee issue 或 GitHub issue，并注明 JDK 与组件版本。
反馈与交流
在使用过程中有遇到任何问题或想法，都可以提交 issue。
或加入微信交流：
