From 8158d214ba68592ec82be6757661f479a8cd71b6 Mon Sep 17 00:00:00 2001 From: Charles7c Date: Thu, 7 Aug 2025 20:19:48 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E6=9B=B4=E6=96=B0=20README=20=E6=96=87?= =?UTF-8?q?=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 58 +++++++++++++++++++++++++++---------------------------- 1 file changed, 29 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index 26e40428..1e6e246e 100644 --- a/README.md +++ b/README.md @@ -37,49 +37,44 @@ ## 简介 -ContiNew Starter（Continue New Starter）基于“约定优于配置”的理念，再次精简常规配置，提供一个更为完整的配置解决方案，帮助开发人员更加快速的集成常用第三方库或工具到 Spring Boot Web 应用程序中。 +ContiNew Starter（Continue New Starter）基于“约定优于配置”理念，进一步精简常规配置，提供完整的配置解决方案，帮助开发人员更快速地将常用第三方库或工具集成到 Spring Boot Web 应用程序中。 -ContiNew Starter 包含了一系列经过企业实践优化的依赖包（如 MyBatis-Plus、SaToken），可轻松集成到应用中，为开发人员减少手动引入依赖及配置的麻烦，为 Spring Boot Web 项目的灵活快速构建提供支持。 +ContiNew Starter 封装了一系列经过企业实践验证的依赖包（如 MyBatis-Plus、SaToken），可轻松集成到应用中，减少开发人员手动引入依赖及配置的工作量，为 Spring Boot Web 项目的灵活快速构建提供支持。 -> ContiNew Starter 源自 [ContiNew Admin](https://github.com/Charles7c/continew-admin) 中后台管理框架/脚手架项目。在 ContiNew Admin 发展到一定程度时，作者发现新手用户上手时需要关注过多的脚手架通用基础能力，而且如果想要在一个全新项目中使用这些基础能力，“迁移”起来也很麻烦。于是，ContiNew Starter 应运而生，作者在 ContiNew Admin 2.x 版本时，将项目中的通用基础能力进行了抽离和深度优化。这样，无论是在 ContiNew Admin 中使用，还是单独使用这些基础能力，都可以更加轻松。 +> ContiNew Starter 源自 [ContiNew Admin](https://github.com/continew-org/continew-admin) 后台管理框架项目。随着 ContiNew Admin 的发展，作者发现初学者需要关注过多的脚手架通用基础能力，且在新项目中复用这些能力时存在迁移困难的问题。于是，ContiNew Starter 应运而生，作者在 ContiNew Admin 2.x 版本时，将项目中的通用基础能力进行了抽离并深度优化。这样，无论是在 ContiNew Admin 中使用，还是单独使用这些基础能力，都可以更加轻松。 ## 解决痛点 在开发一个 Java Web 项目之前，我们可能需要做如下准备工作： -1. 引入 Spring Boot 父项目进行版本锁定（无 Spring 不 Java） -2. 引入 Spring Boot Web 依赖 -3. 根据自身需要引入不同组件的 Starter -4. 根据自身需要对引入的 Starter 进行配置（查阅文档或通过搜索引擎查找常用配置） - 1. 编写 Java 配置 - 2. 编写 application.yml 配置 -5. 编写各种全局处理器 -6. 开始使用 +1. 引入 Spring Boot 父项目进行版本锁定（无 Spring 不 Java）。 +2. 引入 Spring Boot Web 依赖。 +3. 根据需求引入不同组件的 Starter。 +4. 针对引入的 Starter 进行配置（查阅文档或通过搜索引擎查找常用配置）。 + - 编写 Java 配置。 + - 编写 application.yml 配置。 +5. 编写各类全局处理器。 +6. 开始业务开发。 在 Spring Boot “约定优于配置” 理念的帮助下，我们开发一个 Spring Java Web 程序已经简化到了不可思议的程度，而且很多设计良好的组件 Starter 提供了极大的扩展性，提供了非常多的配置，给使用者最大的可行性，当你需要处理一些自定义场景时，这些配置简直是太过方便。 -然而，极大的扩展性带来的另一面就是配置“混乱”，对于小白用户，初步使用某个组件时，仅配置就足够“吃一壶”。因此，各种脚手架项目应运而生，你可能会想，这基础配置关脚手架项目什么事？**脚手架项目的作用不仅仅是提供一系列通用基础功能，更多的是提供了一种通用的解决方案，无论是针对所使用组件的配置，还是实现的某个功能的设计，亦或是开发规范** 。即使是一个小白，把脚手架项目拿过来，只需要删减下不需要的功能，改动下品牌元素，就可以继续在其基础上进行开发一个成熟的项目。 +然而，高度扩展性也带来了配置复杂性，新手用户在初次使用组件时往往需要花费大量精力在配置上。因此，各种脚手架项目应运而生，你可能会想，这基础配置关脚手架项目什么事？**脚手架项目的作用不仅仅是提供一系列通用基础功能，更多的是提供了一种通用的解决方案，无论是针对所使用组件的配置，还是实现的某个功能的设计，亦或是开发规范** 。即使是初学者，把脚手架项目拿过来，只需要删减不需要的功能，修改品牌元素，就可以继续在其基础上进行开发一个成熟的项目。 -ContiNew Starter 就是将脚手架项目中的通用基础配置进行了封装及深度优化，从企业通用实践层面精简配置，让一个完全从头开始或已有的项目，在使用部分组件时变得更轻松。 +ContiNew Starter 将脚手架项目中的通用基础配置进行封装与深度优化，从企业实践角度精简配置，使新项目或已有项目在使用这些组件时更加便捷。 ## 项目源码 -| 开源平台 | 源码地址 | -| :------------ | :----------------------------------------------- | -| Gitee（码云） | https://gitee.com/continew/continew-starter | -| GitCode | https://gitcode.com/continew/continew-starter | -| GitHub | https://github.com/continew-org/continew-starter | +| 开源平台 | 源码地址 | +|:--------|:-------------------------------------------------| +| GitCode | https://gitcode.com/continew/continew-starter | +| Gitee | https://gitee.com/continew/continew-starter | +| GitHub | https://github.com/continew-org/continew-starter | ## 像数1，2，3一样容易 -1.在项目 pom.xml 中锁定版本（**下方两种方式请任选其一**） +1.在项目 pom.xml 中锁定版本（**以下两种方式任选其一**） -第一种方式：如您使用的是 Spring Boot Parent 的方式，则替换 Spring Boot Parent 为 ContiNew Starter - -> 最新稳定版（latest-version） - -Release - +方式一：如您使用的是 Spring Boot Parent 的方式，则替换 Spring Boot Parent 为 ContiNew Starter。 ```xml @@ -89,7 +84,7 @@ ContiNew Starter 就是将脚手架项目中的通用基础配置进行了封装 ``` -第二种方式：如您使用的是引入 Spring Boot Dependencies 的方式，则替换 Spring Boot Dependencies 为 ContiNew Starter Dependencies +方式二：如您使用的是引入 Spring Boot Dependencies 的方式，则替换 Spring Boot Dependencies 为 ContiNew Starter Dependencies ```xml @@ -125,9 +120,9 @@ ContiNew Starter 就是将脚手架项目中的通用基础配置进行了封装 ``` -3.在 application.yml 中根据引入模块，添加所需配置 +3.在 application.yml 中根据引入模块，添加所需配置 -e.g. 跨域配置 +示例：跨域配置 ```yaml --- ### 跨域配置 @@ -243,7 +238,12 @@ ContiNew 系列项目采用清晰的分支策略，确保开发与维护有序 ## 反馈交流 -欢迎各位小伙伴儿扫描下方二维码加入项目交流群，与项目维护团队及其他大佬用户实时交流讨论。 +感谢您对 ContiNew 开源项目的关注与支持！我们非常重视每一位用户的反馈和建议，这是推动项目不断进步的动力。 欢迎扫描下方二维码加入我们的官方交流群，与项目维护团队及其他大佬用户实时交流探讨。 + +- 与项目核心团队直接沟通，获取第一手项目动态 +- 解决使用过程中遇到的问题，分享经验心得 +- 参与功能讨论和需求收集，影响项目未来发展 +- 结识志同道合的技术爱好者，扩展人脉圈
二维码