同步操作将从 ContiNew/continew-starter 强制同步,此操作会覆盖自 Fork 仓库以来所做的任何修改,且无法恢复!!!
确定后同步将在后台操作,完成时将刷新页面,请耐心等待。
ContiNew Starter(Continue New Starter)基于“约定优于配置”的理念,再次精简常规配置,提供一个更为完整的配置解决方案,帮助开发人员更加快速的集成常用第三方库或工具到 Spring Boot Web 应用程序中。
ContiNew Starter 包含了一系列经过企业实践优化的依赖包(如 MyBatis-Plus、SaToken),可轻松集成到应用中,为开发人员减少手动引入依赖及配置的麻烦,为 Spring Boot Web 项目的灵活快速构建提供支持。
ContiNew Starter 源自 ContiNew Admin 中后台管理框架/脚手架项目。在 ContiNew Admin 发展到一定程度时,作者发现新手用户上手时需要关注过多的脚手架通用基础能力,而且如果想要在一个全新项目中使用这些基础能力,“迁移”起来也很麻烦。于是,ContiNew Starter 应运而生,作者在 ContiNew Admin 2.x 版本时,将项目中的通用基础能力进行了抽离和深度优化。这样,无论是在 ContiNew Admin 中使用,还是单独使用这些基础能力,都可以更加轻松。
在开发一个 Java Web 项目之前,我们可能需要做如下准备工作:
在 Spring Boot “约定优于配置” 理念的帮助下,我们开发一个 Spring Java Web 程序已经简化到了不可思议的程度,而且很多设计良好的组件 Starter 提供了极大的扩展性,提供了非常多的配置,给使用者最大的可行性,当你需要处理一些自定义场景时,这些配置简直是太过方便。
然而,极大的扩展性带来的另一面就是配置“混乱”,对于小白用户,初步使用某个组件时,仅配置就足够“吃一壶”。因此,各种脚手架项目应运而生,你可能会想,这基础配置关脚手架项目什么事?脚手架项目的作用不仅仅是提供一系列通用基础功能,更多的是提供了一种通用的解决方案,无论是针对所使用组件的配置,还是实现的某个功能的设计,亦或是开发规范 。即使是一个小白,把脚手架项目拿过来,只需要删减下不需要的功能,改动下品牌元素,就可以继续在其基础上进行开发一个成熟的项目。
ContiNew Starter 就是将脚手架项目中的通用基础配置进行了封装及深度优化,从企业通用实践层面精简配置,让一个完全从头开始或已有的项目,在使用部分组件时变得更轻松。
开源平台 | 源码地址 |
---|---|
GitHub | https://github.com/Charles7c/continew-starter |
Gitee(码云) | https://gitee.com/continew/continew-starter |
1.在项目 pom.xml 中锁定版本(下方两种方式请任选其一)
第一种方式:如您使用的是 Spring Boot Parent 的方式,则替换 Spring Boot Parent 为 ContiNew Starter
<parent>
<groupId>top.charles7c.continew</groupId>
<artifactId>continew-starter</artifactId>
<version>{latest-version}</version>
</parent>
第二种方式:如您使用的是引入 Spring Boot Dependencies 的方式,则替换 Spring Boot Dependencies 为 ContiNew Starter Dependencies
<properties>
<java.version>17</java.version>
<maven.compiler.source>${java.version}</maven.compiler.source>
<maven.compiler.target>${java.version}</maven.compiler.target>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>
<dependencyManagement>
<dependencies>
<!-- ContiNew Starter Dependencies -->
<dependency>
<groupId>top.charles7c.continew</groupId>
<artifactId>continew-starter-dependencies</artifactId>
<version>{latest-version}</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>
2.在项目 pom.xml 中引入所需模块依赖
<dependencies>
<!-- Web 模块 -->
<dependency>
<groupId>top.charles7c.continew</groupId>
<artifactId>continew-starter-web</artifactId>
</dependency>
</dependencies>
3.在 application.yml 中根据引入模块,添加所需配置
e.g. 跨域配置
--- ### 跨域配置
continew-starter.web:
cors:
enabled: true
# 配置允许跨域的域名
allowed-origins: '*'
# 配置允许跨域的请求方式
allowed-methods: '*'
# 配置允许跨域的请求头
allowed-headers: '*'
# 配置允许跨域的响应头
exposed-headers: '*'
注意: 快照版本目前处于开发测试阶段,其中很多特性或改动尚不稳定,可能会因为修复或优化而频繁调整。因此,仅可用于体验,切勿用于生产环境!
1.在项目 pom.xml 中配置 SNAPSHOT(快照)仓库地址(如果你已配有其他仓库地址,追加下方快照仓库地址即可)
<repositories>
<repository>
<id>sonatype-nexus-snapshots</id>
<name>Sonatype Nexus Snapshots</name>
<url>https://s01.oss.sonatype.org/content/repositories/snapshots/</url>
<snapshots>
<updatePolicy>always</updatePolicy>
<enabled>true</enabled>
</snapshots>
</repository>
</repositories>
2.将 ContiNew Starter 版本改为对应快照版本,例如:1.3.0-SNAPSHOT
模块名称 | 模块说明 | 依赖版本 |
---|---|---|
continew-starter-core | 核心模块:包含线程池、项目等自动配置 |
Spring Boot:3.1.8 Hutool:5.8.25 mica-ip2region:3.1.7 |
模块名称 | 模块说明 | 依赖版本 |
---|---|---|
continew-starter-json-jackson | Jackson 序列化等配置 | Jackson:2.15.3 |
模块名称 | 模块说明 | 依赖版本 |
---|---|---|
continew-starter-api-doc | Knife4j 自动配置 | Knife4j:4.5.0 |
模块名称 | 模块说明 | 依赖版本 |
---|---|---|
continew-starter-security-password | 密码编码器 | |
continew-starter-security-mask | JSON 脱敏 | |
continew-starter-security-crypto | 数据库字段加/解密 | |
continew-starter-security-all |
模块名称 | 模块说明 | 依赖版本 |
---|---|---|
continew-starter-web | 跨域、全局异常、错误处理等自动配置 |
Undertow:2.3.10.Final TLog:1.5.1 |
模块名称 | 模块说明 | 依赖版本 |
---|---|---|
continew-starter-log-core | 日志核心模块 | |
continew-starter-log-httptrace-pro | Spring Boot Actuator HttpTrace 重置增强版 |
模块名称 | 模块说明 | 依赖版本 |
---|---|---|
continew-starter-storage-local | 本地存储 |
模块名称 | 模块说明 | 依赖版本 |
---|---|---|
continew-starter-file-excel | Excel 相关配置 | Easy Excel:3.3.3 |
模块名称 | 模块说明 | 依赖版本 |
---|---|---|
continew-starter-captcha-graphic | 图形验证码 | Easy Captcha:1.6.2 |
continew-starter-captcha-behavior | 行为验证码 | AJ-Captcha:1.3.0 |
模块名称 | 模块说明 | 依赖版本 |
---|---|---|
continew-starter-cache-redisson | Redisson 自动配置 | Redisson:3.26.0 |
continew-starter-cache-springcache | Spring Cache 自动配置 | |
continew-starter-cache-jetcache | JetCache 自动配置 |
模块名称 | 模块说明 | 依赖版本 |
---|---|---|
continew-starter-data-core | 数据访问核心模块 | |
continew-starter-data-mybatis-plus | MyBatis Plus 自动配置 |
MyBatis Plus:3.5.5 dynamic-datasource-spring-boot-starter:4.3.0 P6Spy:3.9.1 |
模块名称 | 模块说明 | 依赖版本 |
---|---|---|
continew-starter-auth-satoken | SaToken 自动配置 | Sa-Token:1.37.0 |
continew-starter-auth-justauth | JustAuth 自动配置 | Just Auth:1.16.6 |
模块名称 | 模块说明 | 依赖版本 |
---|---|---|
continew-starter-messaging-mail | 邮件 | Jakarta Mail:1.1.0 |
continew-starter-messaging-sms | 短信 | SMS4J:3.1.1 |
模块名称 | 模块说明 | 依赖版本 |
---|---|---|
continew-starter-extension-crud | 扩展模块:BaseController 自定义 CRUD API 封装 |
ContiNew Starter 的分支目前分为下个大版本的开发分支和上个大版本的维护分支,PR 前请注意对应分支是否处于维护状态。
分支 | 说明 |
---|---|
dev | 开发分支,默认为下个大版本的 SNAPSHOT 版本,接受新功能或新功能优化 PR |
x.x.x | 维护分支,在 vx.x.x 版本维护期终止前(一般为下个大版本发布前),用于修复上个版本的 Bug,只接受已有功能修复,不接受新功能 PR |
如果您想提交新功能或优化现有代码,可以按照以下步骤操作:
请记住,如果您有任何疑问或需要帮助,我们将随时提供支持。
[!IMPORTANT] 欢迎大家为 ContiNew Starter 贡献代码,我们非常感谢您的支持!为了更好地管理项目,维护者有一些要求:
- 请确保代码、配置文件的结构和命名规范良好,完善的代码注释,并遵循阿里巴巴的 《Java开发手册(黄山版)》 中的代码规范,保证代码质量和可维护性
- 在提交代码前,请按照 Angular 提交规范 编写 commit 的 message(建议在 IntelliJ IDEA 中下载并安装 Git Commit Template 插件,以便按照规范进行 commit)
- 提交代码之前,请关闭所有代码窗口,执行
mvn compile
命令(代码格式化插件会在项目编译时对全局代码进行格式修正),编译通过后,不要再打开查看任何代码窗口,直接提交即可
💬 欢迎各位小伙伴儿扫描下方二维码加好友,备注 cnadmin
,拉你进群,探讨技术、提提需求~
加入交流群后,你将会:
感谢参与贡献的每一位小伙伴🥰
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。