diff --git a/README.md b/README.md index 7dc2971ab683cfdcd281b191377b9ea691b9820b..bebad708880bdad4b2184b5cd488d0a31fd626e0 100644 --- a/README.md +++ b/README.md @@ -1,163 +1,121 @@ -

- It is very convenient for the development of individual microservices, beneficial for the development of web service containers, API interfaces, and zero configuration. -

-

- 👉 http://xhteam.cn/ 👈 -

- -

- - - - - - - - - - - star - - -

- -

- - -

- -------------------------------------------------------------------------------- - -## 📚简介 -cat-boot是一个小而全的微服务框架，它非常方便微服务开发、web服务、IOC容器、集成Redis、Mybatis-puls工具、API接口零配置开发。 - - -## 🛠️包含组件 -| 模块 | 介绍 | -|--|--------------------------------| -| IOC | 控制反转(IOC)是面向对象编程中的一种设计原则，可以用来减少代码之间的耦合度。本质上是把对象创建和对象之间的调用关系交给Cat-Boot来进行管理。 | -| AOP | AOP面向切面编程，采取CGLib实现动态代理，取代了传统纵向继承体系重复性代码（性能监视、安全检查、缓存） | -| 拦截器 | 类实现HandlerInterceptor接口，重写preHandle()，postHandle()，afterCompletion() 三个方法 | -| Web容器服务 | 服务器端的开发。从简单性、可测试性和松耦合的角度而言，服务容器基于Tomcat开发，对Tomcat进行封装 | -| mybatis-plus集成 | 实现对数据库的CRUD操作 | -| Redis集成 | 配置redis连接池，调用RedisTemplate实现 | - -------------------------------------------------------------------------------- - - -## 📦安装 - -### 🍊Maven -在项目的pom.xml添加parent和dependencies中加入以下内容: +📚简介 +Cat Boot 是一个基于 Java 的轻量级开发框架，旨在简化 Spring Boot 类项目的开发流程。它集成了 MyBatis、Redis、AOP、Web 支持等常用模块，提供了自动装配、依赖注入、事务管理、拦截器、文件上传等核心功能，适用于快速构建企业级应用。 + +🛠️包含组件 +- **cat-boot-core**：核心工具类与注解支持，包括 Bean 容器、配置加载、常用工具类等。 +- **cat-boot-starter-web**：Web 模块，提供 MVC 架构支持、Servlet、拦截器、文件上传等功能。 +- **cat-boot-starter-mybatis**：集成 MyBatis，支持自动映射、事务管理、SQL 配置加载等。 +- **cat-boot-starter-redis**：集成 Redis，提供基础的缓存操作模板。 +- **cat-boot-starter-aop**：AOP 支持，提供切面编程能力，包括前置、后置、环绕等通知类型。 +- **cat-boot-plugin**：Maven 插件，用于打包可执行 jar 文件。 + +📦安装 +### 🍊Maven +在 `pom.xml` 中添加以下依赖（根据需要选择模块）： ```xml - - cat-boot + + cn.xhteam.boot - 2.1.0 - - + cat-boot-core + 1.0.0 + + cn.xhteam.boot cat-boot-starter-web - 2.1.0 + 1.0.0 + + + + + cn.xhteam.boot + cat-boot-starter-mybatis + 1.0.0 + + + + + cn.xhteam.boot + cat-boot-starter-redis + 1.0.0 + + + + + cn.xhteam.boot + cat-boot-starter-aop + 1.0.0 ``` -### 📥下载jar +### 📥下载jar +您可以直接从 Maven 仓库或项目发布页面下载 jar 包并手动导入到您的项目中。 -点击以下链接，下载`cat-boot-X.X.X.jar`即可： +### 🚽编译安装 +克隆项目后，使用 Maven 编译并安装到本地仓库： -- [Maven中央库](https://repo1.maven.org/maven2/cn/xhteam/) +```bash +git clone https://gitee.com/xhteam/cat-boot.git +cd cat-boot +mvn clean install +``` -> 🔔️注意 -> cat-boot只支持JDK8+，不能保证所有功能方法可用。 +yml配置案例 +### mybatis-plus配置 +在 `application.yml` 中配置数据库连接信息： -### 🚽编译安装 -1、 创建application.properties或application.yml文件选一种即可，如果不自定义配置，则使用cat-boot框架默认配置 -```yml -#yml配置案例 -server: - port: 9000 -catBoot: +```yaml +spring: datasource: - driverClassName: com.mysql.cj.jdbc.Driver - druid: - url: jdbc:mysql://127.0.0.1:3306/managersystem - username: root - password: 123456 -#mybatis-plus配置 -mybatis-plus: - #指定mapper接口类 - mapper-package: cn.xhteam.mapper - #指定xml文件所在目录 - mapper-locations: mapper -redis: - host: 127.0.0.1 - port: 6379 - database: 14 - password: 123456 -``` -```properties -#properties配置案例 -server.prot=9000 -redis.host=127.0.0.1 -redis.port=6379 -redis.database=1 -redis.password=123456 + url: jdbc:mysql://localhost:3306/your_database?useUnicode=true&characterEncoding=UTF-8&serverTimezone=Asia/Shanghai + username: root + password: root + driver-class-name: com.mysql.cj.jdbc.Driver ``` -2、在项目根目录创建服务启动类,在main方法中调用CatBootApplication.run(),运行main方法启动服务 + +### 指定mapper接口类 +在启动类上使用 `@MapperScan` 注解指定 Mapper 接口所在包： + ```java -package cn.xhteam.boot; -public class Application { - public static void main(String[] args) { - CatBootApplication.run(Application.class,args); +@MapperScan("cn.xhteam.icat.mapper") +public class Main { + public static void main(String[] args) { + CatBootApplication.run(Main.class, args); } } - ``` -### 🚽服务器打包部署 -1、在pom.xml中配置打包插件，需要注意将mainClass换成自己的启动类 -```xml - - - - org.apache.maven.plugins - maven-shade-plugin - - - - cn.test.Application - - - - - - package - - shade - - - - - - -``` -2、打包/运行命令 -```sh -mvn clean install #jar包 +### 指定xml文件所在目录 +在 `application.yml` 中配置 MyBatis XML 映射文件路径： -java -jar ./XXX.jar #运行jar +```yaml +mybatis: + mapper-locations: classpath:mapper/**/*.xml ``` +properties配置案例 +在 `cat-boot.properties` 或 `application.properties` 中配置基础参数： -------------------------------------------------------------------------------- +```properties +# Redis 配置 +redis.host=localhost +redis.port=6379 -### 🐞提供bug反馈或建议 +# MyBatis 配置 +mybatis.mapper-locations=classpath:mapper/**/*.xml +``` + +### 🚽服务器打包部署 +使用 Maven 插件打包成可执行 jar： -提交问题反馈请说明正在使用的JDK版本呢、Cat-Boot版本和相关依赖库版本。 +```bash +mvn clean package +java -jar your-project.jar +``` -- [Gitee issue](https://gitee.com/icats/cat-boot/issues) +或者使用 `cat-boot-plugin` 提供的插件进行打包。 +🐞提供bug反馈或建议 +欢迎提交 Issues 或 Pull Request 到 [Gitee 仓库](https://gitee.com/xhteam/cat-boot)。 \ No newline at end of file