一个基于SpringBoot封装的基础库

yue-library官网 yue-library JavaDoc Spring%20Boot Version Spring%20Cloud Version gitee star github star

-- 主页:https://ylyue.cn/ --

-- QQ群:883630899 --


介绍

  yue-library是一个基于SpringBoot封装的基础库,内置丰富的JDK工具,自动装配了一系列的基础Bean与环境配置项,可用于快速构建SpringCloud项目,让微服务变得更简单。

工程结构

. yue-library
├── yue-library  基础库
│   ├── yue-library-dependencies  父pom
│   ├── yue-library-base          基础库提供了丰富的Java工具包,同时也自动装配了一系列基础Bean等
│   ├── yue-library-web           基础库WebMvc实现,用于servlet项目
│   ├── yue-library-webflux       基础库WebFlux实现,用于响应式编程项目(如:SpringCloudGateway)
│   ├── yue-library-data-jdbc     基于SpringJDBC进行二次封装,拥有着强大性能的同时又不失简单、灵活等
│   ├── yue-library-data-redis    基于SpringRedis进行二次封装,更简单灵活,提供全局token与登录相关特性等
│   ├── yue-library-auth-service  基于SpringSecurity进行二次封装,更简单灵活,提供全局token与登录等特性
│   ├── yue-library-auth-client   auth-client为auth-service客户端模块,提供获取当前登录用户状态信息等特性
│   ├── yue-library-pay           基于pay-java-parent进行二次封装,让你真正做到一行代码实现支付聚合
│   ├── yue-library-cloud-oss
│   └── yue-library-cloud-sms
├── yue-library-samples  基础库示例
│   ├── yue-library-test                yue-library-web代码测试项目:单元测试、接口测试、代码示例
│   ├── yue-library-test-webflux        yue-library-webflux代码测试项目:单元测试、接口测试、代码示例
│   ├── yue-library-template-simple     yue-library模版:SpringBoot项目模版
│   └── yue-library-template-ssc        yue-library模版:SpringCloud项目模版,SOA共享架构(阿里巴巴中台)
└── yue

快速开始

引入项目依赖

maven项目,在pom.xml文件中添加如下一段代码,并将${version}替换为对应版本号:maven-central

<parent>
    <groupId>ai.ylyue</groupId>
    <artifactId>yue-library-dependencies</artifactId>
    <version>${version}</version>
</parent>

随后引入所需要的模块,如基础库:yue-library-base

<dependencies>
    <dependency>
        <groupId>ai.ylyue</groupId>
        <artifactId>yue-library-base</artifactId>
    </dependency>
    ...
</dependencies>

版本说明

  yue-library的版本命名方式,采用SpringCloud版本名作为前缀,然后以.1、.2、.3...这种形式,目的是为了方便区分所依赖的SpringCloud版本。
  yue-library-base为其他模块的基础依赖(简称基础库),所以若需要引入除基础库之外的模块(如:data-jdbc、data-redis),可以不引入yue-library-base

JDK版本 JDK说明 SpringCloud版本 版本说明
JDK8 LTS(Oracle长期支持版本),目前大部分互联网公司采用版本 Finchley JDK8兼容版本,每次新特性发布都会进行一次全面的兼容适配与测试,以供JDK8用户稳定使用
JDK11 LTS(Oracle长期支持版本),作者采用版本 Greenwich JDK11推荐版本,提供更快速的迭代与反馈

更多细节,请查看中文文档

模块说明

yue-library-base(必备)

  yue-library-base提供了丰富的Java工具包,它能够帮助我们简化每一行代码(集成Hutool工具包)。
  同时也自动装配了一系列基础Bean,可在 application.yml 文件中配置关闭,所有配置项皆是以yue.*开头,如:yue.cors.allow=false代表不允许跨域。

  更多详细介绍,请查看中文文档

yue-library-data-jdbc(强烈推荐)

  data-jdbc库基于SpringJDBC进行二次封装,拥有着强大性能的同时又不失简单、灵活。特性如下:

  更多详细介绍,请查看中文文档

yue-library-data-redis(推荐)

  data-redis库基于SpringRedis进行二次封装,更简单灵活,提供全局token与登录等特性:

  更多详细介绍,请查看中文文档

社区

  在Gitter的社区里可以找到yue-library的用户和开发者团队。

参与贡献

欢迎各路好汉一起来参与完善 yue-library,我们期待你的 PR!

  1. Fork 本仓库并从 JDK对应的分支或对应的某个版本 创建你的分支
  2. 如果你添加的代码需要测试,请添加测试,确保单元测试通过(测试代码请放在:yue-library-test中)
  3. 如果你修改了 API,请更新文档
  4. 确保代码风格一致
  5. 提交代码
  6. 新建 Pull Request