微信公众号搜"智元新知"关注
微信扫一扫可直接关注哦!

yue-library 基于 SpringBoot 封装的基础库

程序名称:yue-library

授权协议: Apache-2.0

操作系统: 跨平台

开发语言: Java

yue-library 介绍


一个基于SpringBoot封装的基础库

介绍

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

工程结构

. yue-library
├── yue-library  基础库
│   ├── yue-library-dependencies  父pom
│   ├── yue-library-base          基础库提供了丰富的Java工具包,同时也自动装配了一系列基础Bean等
│   ├── yue-library-data-jdbc     基于SpringJDBC进行二次封装,拥有着强大性能的同时又不失简单、灵活等
│   ├── yue-library-data-redis    基于SpringRedis进行二次封装,更简单灵活,提供全局token与登录相关特性等
│   ├── yue-library-pay           基于pay-java-parent进行二次封装,让你真正做到一行代码实现支付聚合
│   ├── yue-library-cloud-oss
│   └── yue-library-cloud-sms
├── yue-library-samples  基础库示例
│   ├── yue-library-test            yue-library代码测试项目:单元测试、接口测试、代码示例
│   ├── 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版本版本说明
JDK8LTS(Oracle长期支持版本),目前大部分互联网公司采用版本FinchleyJDK8兼容版本,每次新特性发布都会进行一次全面的兼容适配与测试,以供JDK8用户稳定使用
JDK11LTS(Oracle长期支持版本),作者采用版本GreenwichJDK11推荐版本,提供更快速的迭代与反馈

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

模块说明

yue-library-base(必备)

yue-library- base提供了丰富的Java工具包,它能够帮助我们简化每一行代码(集成Hutool工具包)。

同时也自动装配了一系列基础Bean,可在 application.yml
文件中配置关闭,所有配置项皆是以yue.*开头,如:yue.cors.allow=false代表不允许跨域。

  • 丰富的Java基础工具类,对文件、流、加密解密、转码、正则、线程、XML等JDK方法进行封装

  • 认开启热加载、热部署、支持跨域,一键解决联调问题

  • 全局统一异常处理基类,结合Result对象,定位异常更轻松,前端显示更贴切

  • 异步线程池:共用父线程上下文环境,异步执行任务时不丢失token

  • ResultHttp最外层响应对象,更适应Restful风格API

  • validator参数校验器,支持单参数连写与POJO对象(注解)校验等,更多的校验规则,更贴切的国内校验场景。(如:手机号、身份证号码)

  • Convert类型转换器,内置hutool、fastjson、yue三种类型转换规则,判断精确性能强大,未知类型兼容性更强

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

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

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

  • 比SpringJDBC更方便好用、比SpringJPA更简单灵活

  • 无侵入 :data-jdbc 在 SpringJDBC 的基础上进行扩展,只做增强不做改变,简化CRUD操作

  • 依赖管理 :引入即可启动项目,关联druid实现sql全监控

  • 预防sql注入 :内置sql注入剥离器,有效预防sql注入攻击

  • 损耗小 :封装大量经过sql优化处理的CRUD方法,直接面向对象操作,对比原生级CRUD处理,性能基本无损耗甚至更优

  • 通用CRUD操作 :内置通用 DAO,通过继承方式即可实现单表大部分 CRUD 操作

  • 更科学的分页分页参数自动解析,写分页等同于写基本List查询。更有优化型分页sql检查

  • 内置性能分析插件 :可输出SQL语句以及其执行时间,建议开发测试时启用该功能,能有效解决查询

  • 类型强化支持原生级SQL查询,并强化原生查询结果,简单便捷 + 可维护组合(支持全JSON或全DO)

  • CRUD校验 :CRUD操作是否符合预期,更好的避免脏数据的产生与违规操作

  • 全局异常处理 :CRUD操作相关异常统一处理,定位更精准,提示更友好,实现全局Restful风格

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

yue-library-data-redis(推荐)

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

  • 简化使用并拥有Redis原生常用命令所对应的方法

  • 保留SpringRedis所有常用特性:分布式缓存

  • 提供分布式token、分布式锁

  • 封装大量第三方登录特性,使登录更简单易于维护

  • 封装常用的登录判断操作与redis-token解析

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

社区

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

参与贡献

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

  1. Fork 本仓库并从 JDK对应的分支或对应的某个版本 创建你的分支

  2. 如果你添加代码需要测试,请添加测试,确保单元测试通过(测试代码请放在:yue-library-test中)

  3. 如果你修改了 API,请更新文档

  4. 确保代码风格一致

  5. 提交代码

  6. 新建 Pull Request

yue-library 官网

https://ylyue.cn

版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 [email protected] 举报,一经查实,本站将立刻删除。

相关推荐