一个基于SpringBoot封装的基础库
— 主页:https://ylyue.cn/ —
— QQ群:883630899 —
介绍
yue-library是一个基于SpringBoot封装的基础库,内置丰富的JDK工具,并且自动装配了一系列的基础Bean,不仅如此,还可以用于快速构建SpringCloud项目,让微服务变得更简单。
工程结构
- yue-library-dependencies 父pom - yue-library-base 基础库,对JDK的一些常用封装,同时配置一些基础Bean等 - yue-library-data-jdbc 基于SpringJDBC的二次封装,简化SQL查询等 - yue-library-data-redis 基于SpringRedis的二次封装,简化Redis查询等
快速使用
maven项目,在pom.xml文件中添加如下一段代码,并将${version}
替换为对应版本号:
<parent>
<groupId>ai.ylyue</groupId>
<artifactId>yue-library-dependencies</artifactId>
<version>${version}</version>
</parent>
随后引入所需要的模块
<dependencies>
<dependency>
<groupId>ai.ylyue</groupId>
<artifactId>yue-library-base</artifactId>
</dependency>
...
</dependencies>
yue-library的版本命名方式,采用SpringCloud版本名作为前缀,然后以.SR1、.SR2、.SR3…这种形式,目的是为了方便区分基础依赖版本。 同时所有模块皆依赖于基础库,若需要引入除基础库之外的模块(如:data-jdbc、data-redis),可以不用引入此模块。 更多细节,请查看中文文档
模块说明
yue-library-base(必备)
yue-library-base
提供了丰富的Java工具包,它能够帮助我们简化每一行代码(集成Hutool工具包)。 同时也自动装配了一系列基础Bean,可在application.yml文件中配置关闭,所有配置项皆是以yue.*
开头,如:yue.cors.allow=false
代表不允许跨域。
- 丰富的Java基础工具类,对文件、流、加密解密、转码、正则、线程、XML等JDK方法进行封装
Result
Http最外层响应对象,更适应Restful风格API- 默认开启热加载、热部署、支持跨域,一键解决联调问题
- 基于
validator
扩展IPO增强校验注解,更适合国内校验场景。(如:手机号、身份证号码) - 全局统一异常处理基类,结合
Result
对象,定位异常更轻松,前端显示更贴切(可以直接继承使用)
更多详细介绍,请查看中文文档
yue-library-data-jdbc(强烈推荐)
data-jdbc库基于SpringJDBC进行二次封装,拥有着强大的性能的同时又不失简单、灵活。特性如下:
- 比SpringJDBC更方便好用、比SpringJPA更简单灵活
- 支持原生级SQL查询
- 大量经过SQL优化处理的CRUD方法
- 强化原生查询结果(支持:POJO、JSON)
- CRUD预期值判断
更多详细介绍,请查看中文文档
yue-library-data-redis(推荐)
data-jdbc库基于SpringRedis进行二次封装,特性如下:
- 简化使用
- 拥有原生常用命令对应的方法
更多详细介绍,请查看中文文档
社区
在Gitter的社区里可以找到yue-library的用户和开发者团队。
参与贡献
欢迎各路好汉一起来参与完善 yue-library,我们期待你的 PR!
- 贡献代码:代码地址 yue-library ,欢迎提交 Issue 或者 Pull Requests
- Fork 本仓库并从master或某个版本创建你的分支
- 如果你添加的代码需要测试,请添加测试,确保单元测试通过
- 如果你修改了 API,请更新文档
- 确保代码风格一致
- 提交代码
- 新建 Pull Request
- 维护文档:文档地址 yue-library-doc ,欢迎参与翻译和修订