minbox-projects

中文文档
安装 & 入门
组件的使用请查看第一个ApiBoot应用程序

如果你是使用Maven来构建项目,你需要添加ApiBoot的固化版本依赖到你的pom.xml文件内,如下所示:
```
<dependencyManagement>
 <dependencies>
 
 <dependency>
 <groupId>org.minbox.framework</groupId>
 <artifactId>api-boot-dependencies</artifactId>
 <version>${lastVersion}</version>
 <scope>import</scope>
 <type>pom</type>
 </dependency>
 </dependencies>
</dependencyManagement>
```
注意:lastVersion需要替换为最新的ApiBoot版本,请访问<dependencies>  <dependency> <groupId>org.minbox.framework</groupId> <artifactId>api-boot-starter-logging</artifactId> </dependency> </dependencies>

添加完组件我们就可以根据使用指南

作者针对每一个组件都提供了一系列的文章进行讲解,请访问获取帮助

如果在使用ApiBoot的过程中遇到了问题,你可以通过以下途径获取帮助!

查看 https://gitee.com/minbox-projects/api-boot/issues提交你遇到的使用问题。

提交问题建议

每个人可能提出的问题不同,不过也会有一些相同的问题,如果您要提出问题,请遵循以下建议:

在提交问题之前,请搜索issues内是否已经有人提出过该问题。
如果您即将要提出的问题不存在,请创建issue。
请在提出您的问题时提供尽可能有关ApiBoot可能多的信息,比如:ApiBoot的版本、JDK、使用组件等
如果提问题时需要粘贴代码,请尽量使用markdown语法```转义符。

源码方式构建

ApiBoot正式版本都会发布到Maven Center,如果你想使用源码最新版本的ApiBoot(版本并未发布),可以直接通过源码的方式进行构建安装到本地使用,前提条件如下所示:

本地需要配置Maven环境变量,建议JDK1.8下载地址
本地需要配置Git环境变量,# 下载master分支源码到本地 ➜ git clone https://github.com/minbox-projects/api-boot.git # 进入api-boot源码根目录 ➜ cd api-boot # 执行安装 ➜ mvn clean install -Dmaven.test.skip=true -Dmaven.javadoc.skip=true -Dgpg.skip

模块

ApiBoot的源码构建使用到了多个模块,下面是一个快速概述:

api-boot

api-boot模块是编译整个项目的根目录,所提供的能力如下所示:

提供项目统一版本revision的配置
提供项目编译时使用的公共插件(flatten、cobertura...)
提供项目编译时使用的Maven仓库配置
统一项目编译的JDK版本

api-boot-autoconfigure

api-boot-autoconfigure是最为主要的核心模块,内部提供了全部组件的自动化配置类,这一点完全是利用SpringBoot所提供的api-boot-dependencies

该模块的功能与spring-boot-dependencies一致,都是为了固化项目中所使用的依赖版本号,让我们在构建项目中可以很好地对某一个依赖进行升级,不再担心各个依赖之间版本不兼容的困扰。

api-boot-parent

该模块继承自api-boot-dependencies,可直接使用固化版本后的依赖,是构建其他模块的统一父依赖。

api-boot-starters

该模块下定义了开发过程中具体使用的Starter依赖,Starter依赖内不包含任何的框架代码,只有一个pom.xml文件,具体的自动化配置实现以及具体集成第三方的实现分别位于:api-boot-autoconfigure、api-boot-plugins模块内。

使用方式与spring-boot-starter-xxx一致,比如:在项目中集成限流组件,我们只需要在pom.xml中添加api-boot-starter-rate-limiter依赖即可,版本也无需添加,因为已经通过api-boot-dependencies模块进行了固化版本依赖。

api-boot-tools

该模块会定义一些常用到的工具类,比如:ApplicationContext、BeanFactory等。

该模块同样是由api-boot-autoconfigure进行自动化配置,将部分工具类自动注册到IOC。

示例

项目源码中api-boot-samples模块提供了各个组件的使用示例,也可以结合我博客文章来学习使用,详情请访问:推荐开源项目

项目名称	作者	项目地址
分布式链路日志开源框架	恒宇少年	https://gitee.com/minbox-projects/minbox-logging
SpringBoot_v2	bdj	https://gitee.com/bdj/SpringBoot_v2
Pear Admin Layui	就眠仪式	https://gitee.com/Jmysy/Pear-Admin-Layui