style: 全项目统一 Tab 缩进并补全尾随逗号
This commit is contained in:
+11
-11
@@ -32,18 +32,18 @@ import org.springframework.context.annotation.ComponentScan
|
||||
*/
|
||||
@AutoConfiguration
|
||||
@ComponentScan(
|
||||
"com.mingliqiye.utils.springboot.bean",
|
||||
"com.mingliqiye.utils.springboot.converters",
|
||||
"com.mingliqiye.utils.springboot.listener",
|
||||
"com.mingliqiye.utils.springboot.bean",
|
||||
"com.mingliqiye.utils.springboot.converters",
|
||||
"com.mingliqiye.utils.springboot.listener",
|
||||
)
|
||||
open class AutoConfiguration {
|
||||
|
||||
/**
|
||||
* 初始化块,在类实例化时执行。
|
||||
*
|
||||
* 调用printBanner方法打印启动横幅,并记录日志表示自动配置成功。
|
||||
*/
|
||||
init {
|
||||
com.mingliqiye.utils.main.Main.printb()
|
||||
}
|
||||
/**
|
||||
* 初始化块,在类实例化时执行。
|
||||
*
|
||||
* 调用printBanner方法打印启动横幅,并记录日志表示自动配置成功。
|
||||
*/
|
||||
init {
|
||||
com.mingliqiye.utils.main.Main.printb()
|
||||
}
|
||||
}
|
||||
|
||||
+31
-31
@@ -36,37 +36,37 @@ import org.springframework.context.annotation.Bean
|
||||
@AutoConfigureAfter(name = ["org.springframework.boot.jackson.autoconfigure.JacksonAutoConfiguration"])
|
||||
open class Jackson3AutoConfiguration {
|
||||
|
||||
private val logger = MingLiLoggerFactory.getLogger<Jackson3AutoConfiguration>()
|
||||
private val logger = MingLiLoggerFactory.getLogger<Jackson3AutoConfiguration>()
|
||||
|
||||
/**
|
||||
* 注册 UUID 的 Jackson 3 序列化/反序列化模块。
|
||||
*
|
||||
* 如需替换 UUID 处理逻辑,注册名为 [UUIDJsonConverterJsonMapperCustomizer]
|
||||
* 的 [JsonMapperBuilderCustomizer] Bean 即可,本 Bean 将自动跳过。
|
||||
*/
|
||||
@Bean("UUIDJsonConverterJsonMapperCustomizer")
|
||||
@ConditionalOnMissingBean(name = ["UUIDJsonConverterJsonMapperCustomizer"])
|
||||
open fun getUUIDJsonConverterJsonMapperCustomizer(): JsonMapperBuilderCustomizer {
|
||||
return JsonMapperBuilderCustomizer { builder ->
|
||||
builder.addModule(UUIDJsonConverter.getJsonConverter().getJackson3Module())
|
||||
}.also {
|
||||
logger.info("MingliUtils Jackson3 UUID Serializers created")
|
||||
}
|
||||
}
|
||||
/**
|
||||
* 注册 UUID 的 Jackson 3 序列化/反序列化模块。
|
||||
*
|
||||
* 如需替换 UUID 处理逻辑,注册名为 [UUIDJsonConverterJsonMapperCustomizer]
|
||||
* 的 [JsonMapperBuilderCustomizer] Bean 即可,本 Bean 将自动跳过。
|
||||
*/
|
||||
@Bean("UUIDJsonConverterJsonMapperCustomizer")
|
||||
@ConditionalOnMissingBean(name = ["UUIDJsonConverterJsonMapperCustomizer"])
|
||||
open fun getUUIDJsonConverterJsonMapperCustomizer(): JsonMapperBuilderCustomizer {
|
||||
return JsonMapperBuilderCustomizer { builder ->
|
||||
builder.addModule(UUIDJsonConverter.getJsonConverter().getJackson3Module())
|
||||
}.also {
|
||||
logger.info("MingliUtils Jackson3 UUID Serializers created")
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* 注册日期时间的 Jackson 3 序列化/反序列化模块。
|
||||
*
|
||||
* 如需替换日期时间处理逻辑,注册名为 [DateTimeJsonConverterJsonMapperCustomizer]
|
||||
* 的 [JsonMapperBuilderCustomizer] Bean 即可,本 Bean 将自动跳过。
|
||||
*/
|
||||
@Bean("DateTimeJsonConverterJsonMapperCustomizer")
|
||||
@ConditionalOnMissingBean(name = ["DateTimeJsonConverterJsonMapperCustomizer"])
|
||||
open fun getDateTimeJsonConverterJsonMapperCustomizer(): JsonMapperBuilderCustomizer {
|
||||
return JsonMapperBuilderCustomizer { builder ->
|
||||
builder.addModule(DateTimeJsonConverter.getJsonConverter().getJackson3Module())
|
||||
}.also {
|
||||
logger.info("MingliUtils Jackson3 DateTime Serializers created")
|
||||
}
|
||||
}
|
||||
/**
|
||||
* 注册日期时间的 Jackson 3 序列化/反序列化模块。
|
||||
*
|
||||
* 如需替换日期时间处理逻辑,注册名为 [DateTimeJsonConverterJsonMapperCustomizer]
|
||||
* 的 [JsonMapperBuilderCustomizer] Bean 即可,本 Bean 将自动跳过。
|
||||
*/
|
||||
@Bean("DateTimeJsonConverterJsonMapperCustomizer")
|
||||
@ConditionalOnMissingBean(name = ["DateTimeJsonConverterJsonMapperCustomizer"])
|
||||
open fun getDateTimeJsonConverterJsonMapperCustomizer(): JsonMapperBuilderCustomizer {
|
||||
return JsonMapperBuilderCustomizer { builder ->
|
||||
builder.addModule(DateTimeJsonConverter.getJsonConverter().getJackson3Module())
|
||||
}.also {
|
||||
logger.info("MingliUtils Jackson3 DateTime Serializers created")
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
+37
-37
@@ -66,42 +66,42 @@ import tools.jackson.databind.json.JsonMapper
|
||||
@AutoConfigureAfter(name = ["com.mingliqiye.utils.springboot.autoconfigure.Jackson3AutoConfiguration"])
|
||||
open class Jackson3JsonApiAutoConfiguration {
|
||||
|
||||
companion object {
|
||||
private val logger = MingLiLoggerFactory.getLogger<Jackson3JsonApiAutoConfiguration>()
|
||||
}
|
||||
companion object {
|
||||
private val logger = MingLiLoggerFactory.getLogger<Jackson3JsonApiAutoConfiguration>()
|
||||
}
|
||||
|
||||
/**
|
||||
* 创建并注册默认的 [JsonApi] Bean。
|
||||
*
|
||||
* 使用容器中的 [JsonMapper] 构造 [Jackson3JsonApi]。读取器直接返回该 [JsonMapper];
|
||||
* 写入器被设计为抛出 [JsonException],即本实现不允许通过 [JsonApi] 替换底层
|
||||
* `JsonMapper`,底层实例由 Spring 容器统一管理。
|
||||
*
|
||||
* 创建完成后会尝试初始化全局 [JSONA]:
|
||||
* - 若 [JSONA] 尚未设置,则设置为本实例;
|
||||
* - 若已设置,则保留既有实现。
|
||||
*
|
||||
* 该 Bean 仅在容器中不存在其他 [JsonApi] 时创建。
|
||||
*
|
||||
* @param jsonMapper 容器中的 Jackson 3 映射器
|
||||
* @return 基于 Jackson 3 的 JSON 访问门面
|
||||
*/
|
||||
@Bean
|
||||
@ConditionalOnMissingBean(JsonApi::class)
|
||||
open fun jsonApi(jsonMapper: JsonMapper): JsonApi {
|
||||
return Jackson3JsonApi(
|
||||
get = { jsonMapper },
|
||||
set = { throw JsonException("JSON API set method is not allowed.") })
|
||||
.also {
|
||||
logger.info("JsonApi Bean Auto Configuration Success")
|
||||
try {
|
||||
JSONA.getJsonApi()
|
||||
} catch (_: NullPointerException) {
|
||||
JSONA.setJsonApi(it)
|
||||
logger.info(
|
||||
"JSONA Using {}", it.javaClass.name
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
/**
|
||||
* 创建并注册默认的 [JsonApi] Bean。
|
||||
*
|
||||
* 使用容器中的 [JsonMapper] 构造 [Jackson3JsonApi]。读取器直接返回该 [JsonMapper];
|
||||
* 写入器被设计为抛出 [JsonException],即本实现不允许通过 [JsonApi] 替换底层
|
||||
* `JsonMapper`,底层实例由 Spring 容器统一管理。
|
||||
*
|
||||
* 创建完成后会尝试初始化全局 [JSONA]:
|
||||
* - 若 [JSONA] 尚未设置,则设置为本实例;
|
||||
* - 若已设置,则保留既有实现。
|
||||
*
|
||||
* 该 Bean 仅在容器中不存在其他 [JsonApi] 时创建。
|
||||
*
|
||||
* @param jsonMapper 容器中的 Jackson 3 映射器
|
||||
* @return 基于 Jackson 3 的 JSON 访问门面
|
||||
*/
|
||||
@Bean
|
||||
@ConditionalOnMissingBean(JsonApi::class)
|
||||
open fun jsonApi(jsonMapper: JsonMapper): JsonApi {
|
||||
return Jackson3JsonApi(
|
||||
get = { jsonMapper },
|
||||
set = { throw JsonException("JSON API set method is not allowed.") })
|
||||
.also {
|
||||
logger.info("JsonApi Bean Auto Configuration Success")
|
||||
try {
|
||||
JSONA.getJsonApi()
|
||||
} catch (_: NullPointerException) {
|
||||
JSONA.setJsonApi(it)
|
||||
logger.info(
|
||||
"JSONA Using {}", it.javaClass.name
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
+26
-26
@@ -46,32 +46,32 @@ import org.springframework.context.annotation.Primary
|
||||
open class JacksonJsonApiAutoConfiguration {
|
||||
|
||||
|
||||
companion object {
|
||||
private val log: Logger = MingLiLoggerFactory.getLogger("MingliUtils-JacksonAutoConfiguration")
|
||||
}
|
||||
companion object {
|
||||
private val log: Logger = MingLiLoggerFactory.getLogger("MingliUtils-JacksonAutoConfiguration")
|
||||
}
|
||||
|
||||
|
||||
/*
|
||||
* 创建并返回一个 JsonApi Bean 实例。
|
||||
* 该方法会在没有其他 JsonApi Bean 存在时被调用,并将创建的 JacksonJsonApi 实例设置为全局默认的 JSON API。
|
||||
*
|
||||
* @param objectMapper 用于 JSON 操作的 ObjectMapper 实例。
|
||||
* @return 返回配置好的 JsonApi 实例。
|
||||
*/
|
||||
@Bean
|
||||
@Primary
|
||||
@ConditionalOnMissingBean(JsonApi::class)
|
||||
open fun jsonApi(objectMapper: ObjectMapper): JsonApi {
|
||||
return JacksonJsonApi(objectMapper).also {
|
||||
log.info("JsonApi Bean Auto Configuration Success")
|
||||
try {
|
||||
JSONA.getJsonApi()
|
||||
} catch (_: NullPointerException) {
|
||||
JSONA.setJsonApi(it)
|
||||
log.info(
|
||||
"JSONA Using {}", it.javaClass.name
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
/*
|
||||
* 创建并返回一个 JsonApi Bean 实例。
|
||||
* 该方法会在没有其他 JsonApi Bean 存在时被调用,并将创建的 JacksonJsonApi 实例设置为全局默认的 JSON API。
|
||||
*
|
||||
* @param objectMapper 用于 JSON 操作的 ObjectMapper 实例。
|
||||
* @return 返回配置好的 JsonApi 实例。
|
||||
*/
|
||||
@Bean
|
||||
@Primary
|
||||
@ConditionalOnMissingBean(JsonApi::class)
|
||||
open fun jsonApi(objectMapper: ObjectMapper): JsonApi {
|
||||
return JacksonJsonApi(objectMapper).also {
|
||||
log.info("JsonApi Bean Auto Configuration Success")
|
||||
try {
|
||||
JSONA.getJsonApi()
|
||||
} catch (_: NullPointerException) {
|
||||
JSONA.setJsonApi(it)
|
||||
log.info(
|
||||
"JSONA Using {}", it.javaClass.name
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
+23
-23
@@ -63,30 +63,30 @@ import org.springframework.context.annotation.Bean
|
||||
@AutoConfigureAfter(name = ["org.springframework.boot.autoconfigure.jackson.JacksonAutoConfiguration"])
|
||||
open class JacksonJsonAutoConfiguration {
|
||||
|
||||
companion object {
|
||||
private val log = MingLiLoggerFactory.getLogger<JacksonJsonAutoConfiguration>()
|
||||
}
|
||||
companion object {
|
||||
private val log = MingLiLoggerFactory.getLogger<JacksonJsonAutoConfiguration>()
|
||||
}
|
||||
|
||||
@Bean("DateTimeJsonConverterJackson2ObjectMapperBuilderCustomizer")
|
||||
@ConditionalOnMissingBean(name = ["DateTimeJsonConverterJackson2ObjectMapperBuilderCustomizer"])
|
||||
fun getDateTimeJsonConverterJackson2ObjectMapperBuilderCustomizer() = Jackson2ObjectMapperBuilderCustomizer {
|
||||
log.info(
|
||||
"MingliUtils Jackson2 DateTime Serializers created"
|
||||
)
|
||||
it.modulesToInstall { modules ->
|
||||
modules.add(DateTimeJsonConverter.getJsonConverter().getJacksonModule())
|
||||
}
|
||||
}
|
||||
@Bean("DateTimeJsonConverterJackson2ObjectMapperBuilderCustomizer")
|
||||
@ConditionalOnMissingBean(name = ["DateTimeJsonConverterJackson2ObjectMapperBuilderCustomizer"])
|
||||
fun getDateTimeJsonConverterJackson2ObjectMapperBuilderCustomizer() = Jackson2ObjectMapperBuilderCustomizer {
|
||||
log.info(
|
||||
"MingliUtils Jackson2 DateTime Serializers created"
|
||||
)
|
||||
it.modulesToInstall { modules ->
|
||||
modules.add(DateTimeJsonConverter.getJsonConverter().getJacksonModule())
|
||||
}
|
||||
}
|
||||
|
||||
@Bean("UUIDJsonConverterJackson2ObjectMapperBuilderCustomizer")
|
||||
@ConditionalOnMissingBean(name = ["UUIDJsonConverterJackson2ObjectMapperBuilderCustomizer"])
|
||||
fun getUUIDJsonConverterJackson2ObjectMapperBuilderCustomizer() = Jackson2ObjectMapperBuilderCustomizer {
|
||||
log.info(
|
||||
"MingliUtils Jackson2 UUID Serializers created"
|
||||
)
|
||||
it.modulesToInstall { modules ->
|
||||
modules.add(UUIDJsonConverter.getJsonConverter().getJacksonModule())
|
||||
}
|
||||
}
|
||||
@Bean("UUIDJsonConverterJackson2ObjectMapperBuilderCustomizer")
|
||||
@ConditionalOnMissingBean(name = ["UUIDJsonConverterJackson2ObjectMapperBuilderCustomizer"])
|
||||
fun getUUIDJsonConverterJackson2ObjectMapperBuilderCustomizer() = Jackson2ObjectMapperBuilderCustomizer {
|
||||
log.info(
|
||||
"MingliUtils Jackson2 UUID Serializers created"
|
||||
)
|
||||
it.modulesToInstall { modules ->
|
||||
modules.add(UUIDJsonConverter.getJsonConverter().getJacksonModule())
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
+56
-56
@@ -61,63 +61,63 @@ import org.springframework.context.event.EventListener
|
||||
@ConditionalOnClass(name = ["okhttp3.OkHttpClient"])
|
||||
open class Okhttp3AutoConfiguration {
|
||||
|
||||
companion object {
|
||||
val log: Logger = MingLiLoggerFactory.getLogger<Okhttp3AutoConfiguration>()
|
||||
}
|
||||
companion object {
|
||||
val log: Logger = MingLiLoggerFactory.getLogger<Okhttp3AutoConfiguration>()
|
||||
}
|
||||
|
||||
/**
|
||||
* 由本配置创建并注册的 [okhttp3.OkHttpClient] 实例,供上下文关闭时清理使用。
|
||||
*
|
||||
* 当调用方自行声明了 `OkHttpClient` Bean 时,本配置的 Bean 方法不会执行,
|
||||
* 该字段保持 `null`,关闭时的清理逻辑也会相应跳过。
|
||||
*/
|
||||
var okhttp: okhttp3.OkHttpClient? = null
|
||||
/**
|
||||
* 由本配置创建并注册的 [okhttp3.OkHttpClient] 实例,供上下文关闭时清理使用。
|
||||
*
|
||||
* 当调用方自行声明了 `OkHttpClient` Bean 时,本配置的 Bean 方法不会执行,
|
||||
* 该字段保持 `null`,关闭时的清理逻辑也会相应跳过。
|
||||
*/
|
||||
var okhttp: okhttp3.OkHttpClient? = null
|
||||
|
||||
/**
|
||||
* 创建默认的 [okhttp3.OkHttpClient] Bean。
|
||||
*
|
||||
* 依次应用容器中所有 [OkhttpBuilder] 定制器后构建客户端。没有任何定制器时
|
||||
* 也能正常构建([ObjectProvider] 允许零个元素)。
|
||||
*
|
||||
* 该 Bean 仅在容器中不存在其他 `OkHttpClient` 时创建;若调用方已自行声明,
|
||||
* 本方法不会被调用。
|
||||
*
|
||||
* @param builders 容器中的 OkHttp 构建定制器,按 `@Order` 排序后依次应用
|
||||
* @return 构建完成的 OkHttp 客户端
|
||||
*/
|
||||
@Bean
|
||||
@ConditionalOnMissingBean
|
||||
open fun okHttpClient(builders: ObjectProvider<OkhttpBuilder>): okhttp3.OkHttpClient {
|
||||
var connt = 0
|
||||
return okhttp3.OkHttpClient.Builder().let { builder ->
|
||||
var b = builder
|
||||
builders.orderedStream().forEach {
|
||||
b = it.customize(b)
|
||||
connt++
|
||||
}
|
||||
b.build()
|
||||
}.also {
|
||||
okhttp = it
|
||||
log.info("load $connt OkhttpBuilder initialized OkHttpClient successfully")
|
||||
}
|
||||
}
|
||||
/**
|
||||
* 创建默认的 [okhttp3.OkHttpClient] Bean。
|
||||
*
|
||||
* 依次应用容器中所有 [OkhttpBuilder] 定制器后构建客户端。没有任何定制器时
|
||||
* 也能正常构建([ObjectProvider] 允许零个元素)。
|
||||
*
|
||||
* 该 Bean 仅在容器中不存在其他 `OkHttpClient` 时创建;若调用方已自行声明,
|
||||
* 本方法不会被调用。
|
||||
*
|
||||
* @param builders 容器中的 OkHttp 构建定制器,按 `@Order` 排序后依次应用
|
||||
* @return 构建完成的 OkHttp 客户端
|
||||
*/
|
||||
@Bean
|
||||
@ConditionalOnMissingBean
|
||||
open fun okHttpClient(builders: ObjectProvider<OkhttpBuilder>): okhttp3.OkHttpClient {
|
||||
var connt = 0
|
||||
return okhttp3.OkHttpClient.Builder().let { builder ->
|
||||
var b = builder
|
||||
builders.orderedStream().forEach {
|
||||
b = it.customize(b)
|
||||
connt++
|
||||
}
|
||||
b.build()
|
||||
}.also {
|
||||
okhttp = it
|
||||
log.info("load $connt OkhttpBuilder initialized OkHttpClient successfully")
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* 在 Spring 上下文关闭时清理本配置创建的 OkHttp 客户端。
|
||||
*
|
||||
* 执行两步清理:
|
||||
* 1. [okhttp3.ConnectionPool.evictAll] 立即关闭连接池中的空闲连接;
|
||||
* 2. 关闭 [okhttp3.Dispatcher] 的线程池,中断未完成的任务。
|
||||
*
|
||||
* 仅当 [okhttp] 字段非空(即客户端由本配置创建)时执行;
|
||||
* 调用方自行声明的客户端不会被清理。
|
||||
*/
|
||||
@EventListener(ContextClosedEvent::class)
|
||||
open fun handleContextClosed() {
|
||||
okhttp?.let {
|
||||
log.info("Context closed, cleaning up OkHttpClient...")
|
||||
it.connectionPool.evictAll()
|
||||
it.dispatcher.executorService.shutdownNow()
|
||||
}
|
||||
}
|
||||
/**
|
||||
* 在 Spring 上下文关闭时清理本配置创建的 OkHttp 客户端。
|
||||
*
|
||||
* 执行两步清理:
|
||||
* 1. [okhttp3.ConnectionPool.evictAll] 立即关闭连接池中的空闲连接;
|
||||
* 2. 关闭 [okhttp3.Dispatcher] 的线程池,中断未完成的任务。
|
||||
*
|
||||
* 仅当 [okhttp] 字段非空(即客户端由本配置创建)时执行;
|
||||
* 调用方自行声明的客户端不会被清理。
|
||||
*/
|
||||
@EventListener(ContextClosedEvent::class)
|
||||
open fun handleContextClosed() {
|
||||
okhttp?.let {
|
||||
log.info("Context closed, cleaning up OkHttpClient...")
|
||||
it.connectionPool.evictAll()
|
||||
it.dispatcher.executorService.shutdownNow()
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
+1
-1
@@ -26,5 +26,5 @@ import okhttp3.OkHttpClient
|
||||
|
||||
@FunctionalInterface
|
||||
fun interface OkhttpBuilder {
|
||||
fun customize(builder: OkHttpClient.Builder): OkHttpClient.Builder
|
||||
fun customize(builder: OkHttpClient.Builder): OkHttpClient.Builder
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user