DOCUMENTATION_zh.adoc

Boat Spring Boot: 基于 Spring Boot 和 Boat 的 SrcLab 核心库

目录

• Introduction
• 获取
• 用法
  • Core (boat-spring-boot-core)
    • Core
    • Bean
    • Message
    • Task
    • Schedule
    • Exception
  • Web (boat-spring-boot-web)
    • Exception
    • Servlet

Introduction

Boat Spring Boot 是使用 Boat 来支持 spring-boot 框架的库. 它提供许多快速方便的接口和工具, 适配 spring-boot 框架.

Boat Spring Boot 包括:

• Core (boat-spring-boot-core): 核心基础接口和工具;

• Web (boat-spring-boot-web): Web接口和工具;

• boat-spring-boot-test: 测试库依赖管理项目;

• boat-spring-boot-bom: BOM (gradle platform) 项目;

想要导入以上模块, 请使用starters:

• boat-spring-boot-starter

• boat-spring-boot-web-starter

• boat-spring-boot-starter-test

• boat-spring-boot-starter-bom

获取

Gradle

implementation("xyz.srclab.spring.boot:boat-spring-boot-starter:0.0.1")

Maven

<dependency>
    <groupId>xyz.srclab.spring.boot</groupId>
    <artifactId>boat-spring-boot-starter</artifactId>
    <version>0.0.1</version>
</dependency>

源代码

https://github.com/srclab-projects/boat-spring-boot

用法

Core (boat-spring-boot-core)

Core

Core包提供核心接口和工具:

• KeyString: 代表经过编码和加密的字符串, 主要用于非明文配置配置;

• StartGreeting: 定义启动问候信息的接口;

• GreetingProperties: StartGreeting 的配置;

Java Examples

link:../boat-spring-boot-sample/src/test/java/sample/java/xyz/srclab/spring/boot/core/KeyStringSample.java[role=include]

link:../boat-spring-boot-sample/src/test/java/sample/java/xyz/srclab/spring/boot/core/TestKeyString.java[role=include]

link:../boat-spring-boot-sample/src/test/java/sample/java/xyz/srclab/spring/boot/core/GreetingSample.java[role=include]

Kotlin Examples

link:../boat-spring-boot-sample/src/test/kotlin/sample/kotlin/xyz/srclab/spring/boot/core/KeyStringSample.kt[role=include]

link:../boat-spring-boot-sample/src/test/kotlin/sample/kotlin/xyz/srclab/spring/boot/core/GreetingSample.kt[role=include]

Bean

Bean包提供:

• BeanProperties: Bean相关配置;

• BeanLifecyclePostProcessor: Spring Bean 生命周期后置处理器;

• BeanRegistry: 动态bean注册;

Java Examples

link:../boat-spring-boot-sample/src/test/java/sample/java/xyz/srclab/spring/boot/bean/BeanSample.java[role=include]

link:../boat-spring-boot-sample/src/test/java/sample/java/xyz/srclab/spring/boot/bean/MyBeanLifecyclePostProcessor.java[role=include]

link:../boat-spring-boot-sample/src/test/java/sample/java/xyz/srclab/spring/boot/bean/MyBean.java[role=include]

link:../boat-spring-boot-sample/src/test/java/sample/java/xyz/srclab/spring/boot/bean/MyBeanRegistry.java[role=include]

link:../boat-spring-boot-sample/src/test/java/sample/java/xyz/srclab/spring/boot/bean/MyBeanLifecyclePostProcessor.java[role=include]

Kotlin Examples

link:../boat-spring-boot-sample/src/test/kotlin/sample/kotlin/xyz/srclab/spring/boot/bean/BeanSample.kt[role=include]

link:../boat-spring-boot-sample/src/test/kotlin/sample/kotlin/xyz/srclab/spring/boot/bean/MyBeanLifecyclePostProcessor.kt[role=include]

Message

Message包提供:

• ReqMessage: 方便的请求消息定义;

• RespMessage: 方便的返回消息定义;

Task

Task包提供:

• TaskPoolProperties: Task线程池相关配置;

• TaskExecutors: 使用 ThreadPoolProperties 快速构建 TaskExecutor;

• TaskDelegate: Task执行委托器;

Java Examples

link:../boat-spring-boot-sample/src/test/java/sample/java/xyz/srclab/spring/boot/task/TaskSample.java[role=include]

link:../boat-spring-boot-sample/src/test/java/sample/java/xyz/srclab/spring/boot/task/AsyncService.java[role=include]

link:../boat-spring-boot-sample/src/test/java/sample/java/xyz/srclab/spring/boot/task/TaskExecutorConfiguration.java[role=include]

Kotlin Examples

link:../boat-spring-boot-sample/src/test/kotlin/sample/kotlin/xyz/srclab/spring/boot/task/TaskSample.kt[role=include]

Schedule

Schedule包提供:

• ScheduledPoolProperties: 调度器的线程池相关配置;

• TaskSchedulers: 使用 ScheduledPoolProperties 快速构建 TaskScheduler;

Java Examples

link:../boat-spring-boot-sample/src/test/java/sample/java/xyz/srclab/spring/boot/schedule/ScheduleSample.java[role=include]

link:../boat-spring-boot-sample/src/test/java/sample/java/xyz/srclab/spring/boot/schedule/ScheduleService.java[role=include]

link:../boat-spring-boot-sample/src/test/java/sample/java/xyz/srclab/spring/boot/schedule/TaskSchedulerConfiguration.java[role=include]

Kotlin Examples

link:../boat-spring-boot-sample/src/test/kotlin/sample/kotlin/xyz/srclab/spring/boot/schedule/ScheduleSample.kt[role=include]

Exception

Exception包提供:

• EnableExceptionHandlingService: 启动全局异常处理服务的注解;

• ExceptionHandlingService: 全局异常处理服务, 详情请参阅其javadoc;

• ExceptionHandlingComponent, ExceptionHandlingMethod: 为 ExceptionHandlingService 提供异常处理器的注解;

Java Examples

link:../boat-spring-boot-core/src/test/java/test/xyz/srclab/spring/boot/exception/ExceptionServiceTest.java[role=include]

link:../boat-spring-boot-core/src/test/java/test/xyz/srclab/spring/boot/exception/ExceptionHandler.java[role=include]

Kotlin Examples

link:../boat-spring-boot-sample/src/test/kotlin/sample/kotlin/xyz/srclab/spring/boot/exception/ExceptionServiceSample.kt[role=include]

Web (boat-spring-boot-web)

Exception

Web exception 包提供:

• EnableWebExceptionHandling: 开启Web全局异常处理的注解;

• WebStatusException: Web异常基类;

• ExceptionResponseBody: Web异常信息消息体;

Java Examples

link:../boat-spring-boot-sample/src/test/java/sample/java/xyz/srclab/spring/boot/web/exception/WebExceptionSample.java[role=include]

link:../boat-spring-boot-sample/src/test/java/sample/java/xyz/srclab/spring/boot/web/exception/TestController.java[role=include]

link:../boat-spring-boot-sample/src/test/java/sample/java/xyz/srclab/spring/boot/web/exception/ExceptionHandler.java[role=include]

Kotlin Examples

link:../boat-spring-boot-sample/src/test/kotlin/sample/kotlin/xyz/srclab/spring/boot/web/exception/WebExceptionSample.kt[role=include]

Servlet

Servlet包提供:

• WebServlets: 提供 Servlet 相关工具, 如快速构建 ServletRequest, ServletInputStream;

Java Examples

link:../boat-spring-boot-sample/src/test/java/sample/java/xyz/srclab/spring/boot/web/servlet/ServletSample.java[role=include]

link:../boat-spring-boot-sample/src/test/java/sample/java/xyz/srclab/spring/boot/web/servlet/TestController.java[role=include]

link:../boat-spring-boot-sample/src/test/java/sample/java/xyz/srclab/spring/boot/web/servlet/TestFilter.java[role=include]

Kotlin Examples

link:../boat-spring-boot-sample/src/test/kotlin/sample/kotlin/xyz/srclab/spring/boot/web/servlet/ServletSample.kt[role=include]