# boat

**Repository Path**: jinaiai/boat

## Basic Information

- **Project Name**: boat
- **Description**: 基于Spring Boot和Spring Cloud的Java应用开发基础框架，已集成常见技术组件。目标是发展成为企业级快速开发解决方案，对业务系统和后台管理提供快速开发支持
- **Primary Language**: Java
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 3
- **Created**: 2023-11-10
- **Last Updated**: 2023-11-10

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 轻舟框架

## 概述
通过构建统一的框架，我们能够增加技术积累，提高应用开发的标准化、规范化和效率。同时，为了确保框架的功能完整性并避免重复造轮子，我们引入了其他优秀的开源框架。例如，我们集成了若依作为后台权限管理系统，以及tanghc的code-gen作为代码生成器等。

> 说明：Boat-舟也，即可载物，也能渡人，是一种轻快的小船。通常使用轻质材料(如树皮、兽皮、帆布、轻质木材、轻金属)制造而成。
> 框架被命名为轻舟，旨在打造一个轻量级的框架，能适应不同的开发任务，并能快速高效地实现各类业务系统。
>
> 引用《早发白帝城》-李白：
> 朝辞白帝彩云间，千里江陵一日还。
> 两岸猿声啼不住，轻舟已过万重山。

## 框架结构

```
boat-dependencies -- 工程Maven顶级依赖，统一控制版本和依赖
├    ├── pom.xml  --版本控制

├──boat-packages --通用包组件，普通Jar包，不会自动执行
├    ├── boat-package-base --规范类。可以被所有java项目无副作用集成。 异常，基础错误码，远程调用结果，规范日志文件等
├    ├── boat-package-common --通用功能类。能被大部分项目集成，实现零散的通用功能。spring，参数校验，线程池，基础实体类等

├──boat-starters --spring starter类型插件，通常需要增加对应配置文件才能生效
├    ├── boat-starter-jetcache  --缓存工具，基于注解和api方式，提供一级二级缓存
├    ├── boat-starter-xxljob  --分布式调度任务xxljob集成
├    ├── boat-starter-nacos  --配置中心集成
├    ├── boat-starter-pulsar  --pulsar MQ集成
├    ├── boat-starter-fastmybatis  --mybatis相关包
├    ├── boat-starter-springdoc  --实现swagger v3文档
├    ├── boat-starter-prometheus  --实现指标监控系统prometheus
├    ├── boat-starter-p6spy  --实现sql监控
├    ├── boat-starter-openfeign  --实现openfeign集成，用于微服务之间互相调用
├    ├── boat-starter-mockit  --实现对第三方、二方、数据库、内部方法等的mock
├    ├── boat-starter-ruoyi  --实现对后台管理框架若依的集成
├    ├── boat-starter-satoken  --对权限认证框架的包装
├    ├── boat-starter-web  --常见拦截器和功能实现，如日志、跟踪号、验证码等

├──boat-boots --场景化依赖包集成，业务系统只需要引入一个包，即可自动导入一系列依赖包
├    ├── boat-boot-api  --api工程需要依赖的包
├    ├── boat-boot-service  --普通web boot服务工程需要依赖的包
├    ├── boat-boot-cloudservice  --cloud service工程依赖的包

├──boat-platforms --公共平台服务
├    ├── boat-platform-ruoyi -- 若依后台管理系统

├──boat-tools --工具类
├    ├── boat-tool-codegen --代码生成器，基于数据表生成mybatis相关类文件

├──boat-samples --示例工程
├    ├── boat-sample-ddd --领域驱动的示例工程，同时集成了轻舟框架，用于验证框架功能
├    ├── boat-sample-support --服务提供者示例工程，配合ddd项目展示基于Feign的跨服务调用

├──script --脚本目录
├    ├── maven --开发环境本地maven配置文件
├    ├── nacos --Cloud的示例工程依赖的配置
├    ├── sql --示例工程的数据表结构

```