Tropical Fish 开源项目使用教程

Tropical Fish 开源项目使用教程

tropical-fish Pragmatic 风格的 Java EE 后端开发脚手架，开箱即用。基于 SpringBoot，技术选型采用主流的框架（Mybatis-Plus，Redisson，Xxl-job，Swagger）。项目特点：自定义查询语法, 可以自由组装查询条件查询数据，配合代码生成模块，提高研发效率；自定义 service 方法级别的文档生成规则，在业务方法增加必要的注解，可生成方法调用树，快速把握复杂代码业务逻辑。 项目地址: https://gitcode.com/gh_mirrors/tr/tropical-fish

1. 项目介绍

Tropical Fish 是一个基于 SpringBoot 的 Java EE 后端开发脚手架，旨在提供一个开箱即用的开发环境，帮助开发者快速搭建和开发后端应用。该项目采用了主流的技术框架，如 Mybatis-Plus、Redisson、Xxl-job 和 Swagger，以确保项目的稳定性和高效性。

主要特点

• 自定义查询语法：支持自由组装查询条件，方便开发者进行数据查询。
• 代码生成模块：通过定义表结构，自动生成代码，减少重复性工作。
• 文档生成规则：自定义 service 方法级别的文档生成规则，帮助开发者快速生成方法调用树，把握复杂代码业务逻辑。

2. 项目快速启动

环境准备

• JDK 1.8 或更高版本
• Maven 3.x
• MySQL 5.7 或更高版本

快速启动步骤

1. 克隆项目

   git clone https://github.com/gnanquanmama/tropical-fish.git
   cd tropical-fish
   

2. 配置数据库 在 application.yml 文件中配置数据库连接信息：

   spring:
     datasource:
       url: jdbc:mysql://localhost:3306/tropical_fish?useUnicode=true&characterEncoding=utf-8&useSSL=false
       username: root
       password: yourpassword
   

3. 启动项目 使用 Maven 构建并启动项目：

   mvn clean install
   mvn spring-boot:run
   

4. 访问项目 项目启动后，可以通过浏览器访问 http://localhost:8080 查看项目运行情况。

3. 应用案例和最佳实践

应用案例

Tropical Fish 已经被多家公司用于线上产品的开发，其中包括国内某知名日化企业。该企业已将 Tropical Fish 作为基础脚手架，支撑其数字化产品的研发。

最佳实践

• 自定义查询语法：在实际开发中，可以根据业务需求自定义查询语法，提高查询效率。
• 代码生成模块：通过代码生成模块，可以快速生成 CRUD 代码，减少开发时间。
• 文档生成规则：在业务方法中增加必要的注解，自动生成方法调用树，帮助团队快速理解复杂业务逻辑。

4. 典型生态项目

Mybatis-Plus

Mybatis-Plus 是一个 MyBatis 的增强工具，提供了丰富的 CRUD 操作和查询功能，简化了数据库操作。

Redisson

Redisson 是一个基于 Redis 的分布式 Java 对象和服务框架，提供了分布式锁、分布式集合等功能。

Xxl-job

Xxl-job 是一个轻量级的分布式任务调度平台，支持任务的动态管理和调度。

Swagger

Swagger 是一个 API 文档生成工具，可以帮助开发者自动生成 API 文档，方便前后端协作。

通过结合这些生态项目，Tropical Fish 可以构建一个功能强大且易于维护的后端系统。

tropical-fish Pragmatic 风格的 Java EE 后端开发脚手架，开箱即用。基于 SpringBoot，技术选型采用主流的框架（Mybatis-Plus，Redisson，Xxl-job，Swagger）。项目特点：自定义查询语法, 可以自由组装查询条件查询数据，配合代码生成模块，提高研发效率；自定义 service 方法级别的文档生成规则，在业务方法增加必要的注解，可生成方法调用树，快速把握复杂代码业务逻辑。 项目地址: https://gitcode.com/gh_mirrors/tr/tropical-fish