程序包 pro.haichuang.framework.base.annotation

核心注解

请参阅: 说明

注释类型概要

注释类型	说明
EnableControllerAdvice	启用全局 Controller 异常处理自动配置 启用此注解后, 请求中所有未捕获的异常将全部被统一拦截, 友好的将错误码/错误信息/用户提示信息返回给客户端 注意: 当手动捕获异常后将无法进行异常拦截.
EnableControllerLogAspect	启用日志切面 启用此注解后, 会将所有带有 @ApiOperation 注解的的方法相关请求响应数据记录在日志中, 从而更好去根据日志排查请求记录 具体实现请参阅 LogAspect
EnableGlobalCorsConfig	启用全局跨域配置 启用此注解后, 将全局添加跨域配置 具体实现请参阅 GlobalCorsConfig
EnableLogSave	启用权限拦截注解 启用此注解后, 会将带有 @LogSave 注解的方法相关请求与响应进行持久化记录 注意: 需要自定义类继承 AbstractLogSave 抽象类, 在自定义类中实现响应持久化逻辑
EnableRequestTimeoutAspect	启用请求超时切面 启用此注解后, 会将所有带有 @ApiOperation 注解的的方法开启请求超时切面监听, 超时则会抛出请求超时异常, 开发人员需要及时解决请求超时问题 具体实现请参阅 RequestTimeoutAspect
EnumConvertValue	枚举值转换注解 在枚举类中静态方法上标注此注解时, 会通过 EnumConverterFactory 进行 Convert 转换, 主要用于请求参数反序列化等场景 注意: 此注解必须在枚举类方法中标注, 标注的方法必须为静态方法, 形参限制为一个 String 类型, 返回值为当前枚举对象 静态方法代码示例(方法名可自定义): @EnumConvertValue public static [枚举类] convertValue() { return [枚举值]; }
LogSave	日志保存切面 该注解配合 @EnableLogSave 注解使用, 当开启了 @EnableLogSave 后, 在 [Controller] 方法上标注该注解, 从而实现日志持久化记录 注意: 需要自定义类继承 AbstractLogSave 抽象类, 在自定义类中实现响应持久化逻辑

程序包pro.haichuang.framework.base.annotation的说明

核心注解