该项目是一个基于Spring Boot的后端模板,使用了以下技术和工具进行开发和构建。
- 💚 Spring Boot 3.x:使用最新版本的Spring Boot进行开发。
- 📝 MyBatis:使用MyBatis进行数据库操作。
- 📦 MyBatis Plus:使用MyBatis Plus提供更多便捷的数据库操作功能。
- 🧰 Lombok:使用Lombok简化Java代码的编写。
- 🔒 Jasypt:使用Jasypt进行加密和解密操作。
- 📝 Slf4j:使用Slf4j进行日志记录。
- 🎯 AOP:使用AOP实现面向切面编程。
- 📚 Jackson:使用Jackson进行JSON数据的序列化和反序列化。
- 📚 Hutool:使用Hutool提供更多实用的Java工具类。
- 📚 Knife4j:使用Knife4j生成API文档。
- 📚 Jackson:使用Jackson进行JSON数据的序列化和反序列化。
- 📌 JDK:请确保你的JDK版本在11以上。
- 📌 Maven:请确保你的Maven版本在3.6以上。
克隆或下载该项目后,进入项目根目录,执行以下命令来安装依赖:
mvn clean install
├── src/ # 源代码目录
│ ├── main/ # 主目录
│ │ ├── java/ # Java代码目录
│ │ │ ├── config/ # 配置类
│ │ │ ├── controller/ # 控制器类
│ │ │ ├── entity/ # 数据库实体类
│ │ │ ├── mapper/ # MyBatis映射接口
│ │ │ ├── service/ # 服务类
│ │ │ ├── util/ # 工具类
│ │ │ ├── Application.java # Spring Boot应用入口
│ │ ├── resources/ # 资源文件目录
│ │ │ ├── application.yml # 应用配置文件
│ │ ├── test/ # 测试目录
│ │ │ ├── java/ # Java测试代码目录
├── .gitignore # Git忽略文件配置
├── pom.xml # Maven配置文件
├── .editorconfig # 编辑器配置
├── .gitignore # Git忽略文件配置
└── spring-boot-template.iml # IntelliJ IDEA项目文件
## 使用流程
1. 初始化项目(参考上述步骤)。
2. 开发你的应用,根据需要修改或添加控制器、服务类、数据库实体类等。
3. 在 `src/main/resources` 目录中配置你的应用配置文件,例如数据库连接信息、日志配置等。
4. 在 `src/main/java/config` 目录中配置你的配置类,例如数据库连接池配置、AOP切面配置等。
5. 在 `src/main/java/mapper` 目录中使用 MyBatis 注解或 XML 文件配置数据库操作。
6. 在 `src/main/java/service` 目录中编写你的服务类,实现业务逻辑。
7. 在 `src/main/java/controller` 目录中编写你的控制器类,处理请求和返回响应。
8. 在开发过程中使用 Git 进行版本控制,确保代码的可追踪性和团队协作。具体使用方式请参考 [Git 文档](https://git-scm.com/doc)。
9. 在完成开发后,可以使用 Maven 进行项目的构建。具体使用方式请参考 Maven 的官方文档。
## 开发注意事项
- 确保你的项目使用了 Spring Boot 3.x 版本。
- 在开发过程中,推荐使用 IntelliJ IDEA 编辑器,并安装相关插件,例如 Lombok 插件,以提升开发效率。
- 遵循 Git 的代码提交规范,使用语义化的提交信息,方便版本管理和发布。
## 使用方法
1. 安装依赖:
```shell
mvn clean install
- 启动应用:
mvn spring-boot:run
-
在浏览器中打开 http://localhost:8080 进行开发。
-
构建项目:
mvn clean package
- 构建完成后,可以在
target
目录中找到构建后的文件。
欢迎贡献代码,提出问题和建议。请在提交代码前确保通过了代码检查。
本项目基于 MIT 许可证开源。
感谢以下开源项目的贡献:
🚀 现在你可以开始使用 SpringBootTemplate 进行后端项目的开发啦!如果有任何问题或建议,请随时提出。祝你编码愉快!