Java

Euonia Core 模块 API 文档

概述

euonia-core 模块是 Euonia 框架的核心基础模块,提供了一套通用工具类和基础设施组件, 涵盖注解验证、对象池管理、唯一 ID 生成、HTTP 异常模型、反射工具、安全基础类型、元组以及字符串/对象工具等功能。

  • Maven 坐标: com.euonia:core
  • Java 模块名: com.euonia.core

导出包

包名 说明
com.euonia.annotation 自定义验证注解及验证器实现
com.euonia.core 核心工具类:对象池、ID 生成器、优先级队列等
com.euonia.http HTTP 异常模型与请求上下文抽象
com.euonia.reflection 反射工具:类扫描、服务提供、泛型类型处理
com.euonia.security 安全相关:认证异常、用户主体模型
com.euonia.tuple 元组类型:Solo ~ Decet(1 到 10 元素)
com.euonia.utility 通用工具类:断言、对象反射、字符串操作

包详情

com.euonia.annotation

验证注解与验证器框架。通过 @Validation 元注解将验证器关联到注解上, 在运行时对字段或方法参数进行约束校验。

类型 说明
@Range 注解 数值范围约束
RangeValidator 验证器 数值范围验证逻辑
@RegularExpression 注解 正则表达式约束
RegularExpressionValidator 验证器 正则匹配验证逻辑
@Required 注解 必填项约束
RequiredValidator 验证器 非空验证逻辑
@StringLength 注解 字符串长度约束
StringLengthValidator 验证器 字符串长度验证逻辑
@Validation 元注解 关联验证器类
Validator 接口 通用验证器接口

com.euonia.core

核心基础设施组件,包括对象池、多种 ID 生成策略和优先级队列。

类型 说明
DefaultObjectPool 通用对象池实现
DefaultObjectPoolProvider 对象池提供者(单例)
GuidGenerator 工具类 .NET 兼容的 GUID 生成器
GuidType 枚举 GUID 生成策略类型
ObjectId 统一对象 ID(支持多种算法)
ObjectPool 接口 对象池接口定义
ObjectPoolPolicy 接口 对象池策略接口
ObjectPoolProvider 接口 对象池提供者接口
ArgumentNullException 异常类 参数空值守卫(throwIfNull / throwIfNullOrEmpty)
ArgumentOutOfRangeException 异常类 参数范围守卫(throwIfGreaterThan / throwIfLessThan 等)
Pair 记录类 键值对
PriorityQueue 泛型优先级队列
Range 记录类 泛型不可变范围
PriorityValueFinder 工具类 优先级队列值查找器
RandomId 工具类 随机 ID 生成器
ShortUniqueId 短唯一 ID 编码/解码
Singleton 工厂类 线程安全单例工厂
SnowflakeId Snowflake 分布式 ID 生成器
ULID 工具类 ULID 生成器

com.euonia.http

HTTP 异常层次结构与请求上下文抽象。

类型 说明
HttpStatusException HTTP 状态异常基类
BadRequestException 异常类 400 Bad Request
ForbiddenException 异常类 403 Forbidden
ResourceNotFoundException 异常类 404 Not Found
MethodNotAllowedException 异常类 405 Method Not Allowed
ConflictException 异常类 409 Conflict
UpgradeRequiredException 异常类 426 Upgrade Required
TooManyRequestsException 异常类 429 Too Many Requests
RequestTimeoutException 异常类 408 Request Timeout
InternalServerErrorException 异常类 500 Internal Server Error
BadGatewayException 异常类 502 Bad Gateway
ServiceUnavailableException 异常类 503 Service Unavailable
GatewayTimeoutException 异常类 504 Gateway Timeout
RequestContext 请求上下文
RequestContextAccessor final class 请求上下文访问器(ThreadLocal 静态工具类)
RequestContextAwareExecutor 请求上下文感知执行器
RequestContextCopyingDecorator 请求上下文复制装饰器
ResponseHttpStatusCode 注解 HTTP 状态码注解

com.euonia.reflection

反射工具类和服务提供者抽象。

类型 说明
ClassScanner 类路径扫描器
ServiceProvider 接口 服务提供者接口
Generic 抽象类 泛型类型解析
GenericType 抽象类 泛型类型捕获
SyntheticParameterizedType 合成参数化类型
TypeHelper 工具类 类型转换助手
DisplayName 注解 显示名称注解
AmbiguousMethodException 异常类 方法歧义异常
MissingMethodException 异常类 方法缺失异常

com.euonia.security

安全基础设施:认证异常和用户主体。

类型 说明
AccountException 异常类 账户异常
AuthenticationException 异常类 认证异常
CredentialException 异常类 凭证异常
UnauthorizedAccessException 异常类 未授权访问异常
UserClaimTypes 常量类 用户声明类型常量
UserPrincipal 用户主体

com.euonia.tuple

元组类型系列,从 1 元素到 10 元素。

元素数 说明
Tuple 接口 元组基类接口
Solo 1 单元素元组
Duet 2 双元素元组
Trio 3 三元素元组
Quartet 4 四元素元组
Quintet 5 五元素元组
Sextet 6 六元素元组
Septet 7 七元素元组
Octet 8 八元素元组
Nonet 9 九元素元组
Decet 10 十元素元组

com.euonia.utility

通用工具类。

类型 说明
Assert 工具类 断言工具
ObjectUtility 抽象工具类 对象反射操作工具
Resource 工具类 国际化资源文件读取
StringUtility 工具类 字符串操作工具

依赖

  • org.junit.jupiter:junit-jupiter (test)

作者

  • damon (zhaorong@outlook.com)