easy-trans 技术文档

easy-trans 技术文档

【免费下载链接】easy-trans easy-trans是一个数据翻译组件，开发者可以通过一个注解将vo中的id翻译为title、name；可以将字典码sex 1翻译为男/女。支持缓存、微服务等各种各样的有趣玩法。 项目地址: https://gitcode.com/dromara/easy-trans

1. 安装指南

1.1 环境要求

• Java 8+
• Spring Boot 2.x 或 3.x
• 支持的ORM框架：MyBatis Plus/JPA/Beetl SQL/TK MyBatis等

1.2 Maven依赖配置

根据项目使用的ORM框架选择对应的扩展依赖：

核心starter(必须)

<dependency>
    <groupId>com.fhs-opensource</groupId>
    <artifactId>easy-trans-spring-boot-starter</artifactId>
    <version>2.2.9</version>
</dependency>

ORM扩展(选择其一)

<!-- MyBatis Plus扩展 -->
<dependency>
    <groupId>com.fhs-opensource</groupId>
    <artifactId>easy-trans-mybatis-plus-extend</artifactId>
    <version>2.2.9</version>
</dependency>

<!-- JPA扩展 -->
<dependency>
    <groupId>com.fhs-opensource</groupId>
    <artifactId>easy-trans-jpa-extend</artifactId>
    <version>2.2.9</version>
</dependency>

1.3 配置文件

在application.yml中添加配置：

easy-trans:
   is-enable-redis: true  # 是否启用Redis缓存
   is-enable-global: true # 是否启用全局翻译
   is-enable-tile: true   # 是否启用平铺模式
   dict-use-redis: true   # 字典缓存是否使用Redis

2. 使用说明

2.1 基本使用流程

1. POJO类实现TransPojo接口
2. 在需要翻译的字段上添加@Trans注解
3. 访问Controller即可自动翻译

2.2 示例代码

@Data
@Builder
@AllArgsConstructor
@NoArgsConstructor
public class Student implements TransPojo {
    // 字典翻译
    @Trans(type = TransType.DICTIONARY, key = "sex", ref = "sexName")
    private Integer sex;
    
    // 简单翻译(关联其他表)
    @Trans(type = TransType.SIMPLE, target = School.class, fields = "schoolName")
    private String schoolId;
    
    // 枚举翻译
    @Trans(type = TransType.ENUM, key = "desc")
    private StudentType studentType;
}

3. API使用文档

3.1 翻译类型说明

翻译类型	注解示例	说明
字典翻译	@Trans(type = TransType.DICTIONARY, key = "sex")	需要预先缓存字典数据
简单翻译	@Trans(type = TransType.SIMPLE, target = School.class)	自动关联表查询
RPC翻译	@Trans(type = TransType.RPC, targetClassName = "com.fhs.test.pojo.School")	跨微服务翻译
枚举翻译	@Trans(type = TransType.ENUM, key = "desc")	翻译枚举值

3.2 字典服务API

@Autowired
private DictionaryTransService dictionaryTransService;

// 刷新字典缓存
Map<String,String> transMap = new HashMap<>();
transMap.put("0","男");
transMap.put("1","女");
dictionaryTransService.refreshCache("sex",transMap);

4. 项目安装方式

4.1 不使用Redis的配置

在启动类添加排除Redis自动配置：

@SpringBootApplication(exclude = { RedisAutoConfiguration.class })
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

4.2 微服务配置

1. 添加白名单/easyTrans/proxy/**
2. 自定义RestTemplate实现服务间认证

4.3 初始化字典数据

如果项目有字典表，需要在系统启动时初始化字典数据到DictionaryTransService中。

【免费下载链接】easy-trans easy-trans是一个数据翻译组件，开发者可以通过一个注解将vo中的id翻译为title、name；可以将字典码sex 1翻译为男/女。支持缓存、微服务等各种各样的有趣玩法。 项目地址: https://gitcode.com/dromara/easy-trans