介绍 #

easy trans适用于4种场景 #

1 有userId/idCardNo(身份证号码-唯一键场景) 需要 userName，无需联表查询。
2 有gender code 0 需要 男。
3 枚举指定属性给前端
4 反向翻译

亮点 #

1 缓存支持
2 跨微服务翻译支持(User和Order 是2个不同微服务，order里面有userId 需要userName)
3 国际化支持
4 多种ORM框架适配
5 多数据源支持
6 集合支持(userIds [1,2,3] 翻译为张三,李四,王五)
7 反向翻译支持 男->gender 0 张三->user_id 1 陕西分公司 财务部 -> org_id 1

使用步骤 #

技术经理/架构 需要做的事情 #

1 、先把maven 引用加上（主starter+根据自己的ORM框架选择扩展包）
注意：springboot3.x 最新版本为3.1.1 springboot2.x 最新版本为2.3.1
从2.3.0和3.1.0 开始groupId统一改为了org.dromara，在此之前的版本保持com.fhs-opensource

       <dependency>
            <groupId>org.dromara</groupId>
            <artifactId>easy-trans-spring-boot-starter</artifactId>
            <version>2.3.1</version>
        </dependency>

Mybatis plus 扩展：

        <dependency>
            <groupId>org.dromara</groupId>
            <artifactId>easy-trans-mybatis-plus-extend</artifactId>
            <version>2.3.1</version>
        </dependency>

JPA 扩展：

        <dependency>
            <groupId>org.dromara</groupId>
            <artifactId>easy-trans-jpa-extend</artifactId>
            <version>2.3.1</version>
        </dependency>

JPA Springboot3 扩展：

        <dependency>
            <groupId>org.dromara</groupId>
            <artifactId>easy-trans-jpa-sb3-extend</artifactId>
            <version>2.2.3</version>
        </dependency>

Beetl SQL 扩展：

        <dependency>
            <groupId>org.dromara</groupId>
            <artifactId>easy-trans-beetl-sql-extend</artifactId>
            <version>2.3.1</version>
        </dependency>

TK Mybatis(通用mapper) 扩展：

        <dependency>
            <groupId>org.dromara</groupId>
            <artifactId>easy-trans-tk-extend</artifactId>
            <version>2.3.1</version>
        </dependency>

mybatis flex 扩展：

        <dependency>
            <groupId>org.dromara</groupId>
            <artifactId>easy-trans-mybatis-flex-extend</artifactId>
            <version>2.3.1</version>
        </dependency>

easy-query 扩展：

        <dependency>
            <groupId>org.dromara</groupId>
            <artifactId>easy-trans-easy-query-extend</artifactId>
            <version>2.3.1</version>
        </dependency>

如果使用Redis请添加redis的引用(如果之前加过了请不要重复添加)

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-redis</artifactId>
        </dependency>

反向翻译专用扩展，反向翻译的最低版本为：2.2.3-M1，详情见反向翻译章节

<dependency>
    <groupId>org.dromara</groupId>
    <artifactId>easy-trans-untrans-driver</artifactId>
    <version>2.3.1</version>
</dependency>

2、在yaml中添加如下配置

easy-trans:
   #启用redis缓存 如果不用redis请设置为false
   is-enable-redis: true
   #启用全局翻译(拦截所有responseBody进行自动翻译)，如果对于性能要求很高可关闭此配置在方法上使用注解翻译
   is-enable-global: true 
   #启用平铺模式 手动翻译无效
   is-enable-tile: true
   #字典缓存放到redis 微服务模式请开启
   dict-use-redis: true 
   #使用@RpcTrans来标记哪些类可以进行RPC翻译，默认为关闭，多团队协作推荐开启
   is-enable-custom-rpc: true
   # ruoyi相关的框架请开启
   is-enable-map-result: true
   # 反向翻译数据库类型 mysql
   db-type: mysql 
   # Mybatis-plus 为 3.5.3.2版本以上的3.x 版本请设置为true
   mp-new: true
    

3、如果不使用redis，请在启动类加禁用掉redis的自动配置类

@SpringBootApplication(exclude = { RedisAutoConfiguration.class })

4、初始化字典数据(如果你们项目没字典表请忽略)

       @Autowired  //注入字典翻译服务
       private  DictionaryTransService dictionaryTransService;
       //在某处将字典缓存刷新到翻译服务中，以下是demo
       Map<String,String> transMap = new HashMap<>();
       transMap.put("0","男");
       transMap.put("1","女");
       dictionaryTransService.refreshCache("gender",transMap);

5、微服务配置
A、白名单添加 /easyTrans/proxy/** 保证其不被拦截，RPC trans的时候easytrans会自动调用目标微服务的接口来获取数据。
B、应用之间的认证可以通过filter/interceptor实现，然后自定义RestTemplate 保证easytrans在请求用户服务的时候带上需要认证的参数

普通程序员需要做的事情 #

pojo 中添加

@Data
@Builder
@AllArgsConstructor
@NoArgsConstructor
//实现TransPojo  接口，代表这个类需要被翻译或者被当作翻译的数据源
public class Student implements TransPojo {
     // 字典翻译 ref为非必填
    @Trans(type = TransType.DICTIONARY,key = "sex",ref = "sexName")
    private Integer sex;

    //这个字段可以不写，实现了TransPojo接口后有一个getTransMap方法，sexName可以让前端去transMap取
    private String sexName;
    
    //SIMPLE 翻译，用于关联其他的表进行翻译    schoolName 为 School 的一个字段
    @Trans(type = TransType.SIMPLE,target = School.class,fields = "schoolName")
    private String schoolId;
	
	//远程翻译，调用其他微服务的数据源进行翻译
	@Trans(type = TransType.RPC,targetClassName = "com.fhs.test.pojo.School",fields = "schoolName",serviceName = "easyTrans",alias = "middle")
    private String middleSchoolId;
	
	// 枚举翻译，返回文科还是理科给前端
	@Trans(type=TransType.ENUM,key = "desc")
    private StudentType studentType = StudentType.ARTS;

    public static enum StudentType{

        ARTS("文科"),
        SCIENCES("理科");

        private String desc;
        StudentType(String desc){
            this.desc = desc;
        }
    }
}

然后访问你的controller，看返回结果。

easy trans 支持的五种类型 #

字典翻译(TransType.DICTIONARY) #

需要使用者把字典信息刷新到DictionaryTransService 中进行缓存，使用字典翻译的时候取缓存数据源

简单翻译(TransType.SIMPLE) #

比如有userId需要userName或者userPo给前端，原理是组件使用MybatisPlus/JPA的API自动进行查询，把结果放到transMap中。

跨微服务翻译(TransType.RPC) #

比如订单和用户是2个微服务，但是我要在订单详情里展示订单的创建人的用户名，需要用到RPC翻译，原理是订单微服务使用restTemplate调用用户服务的一个统一的接口，把需要翻译的id传过去，然后用户微服务使用MybatisPlus/JPA的API自动进行查询把结果给订单微服务，然后订单微服务拿到数据后进行翻译，当然使用者只是需要一个注解，这些事情都是由组件自动完成的。

AutoTrans(TransType.AUTO) #

还是id翻译name场景，但是使用者如果想组件调用自己写的方法而不通过Mybatis Plus/JPA 的API进行数据查询，就可以使用AutoTrans

枚举翻译(TransType.ENUM) #

比如我要把SEX.BOY 翻译为男，可以用枚举翻译。

项目地址 #

https://gitee.com/dromara/easy_trans

示例项目 #

https://gitee.com/fhs-opensource/easy_trans_springboot_demo

已经使用此插件的企业(非完全统计) #

1、陕西小伙伴网络科技有限公司
2、中软国际云智能业务集团
3、深圳市易流科技股份有限公司
4、陕西逐道科技有限公司
5、深圳市易联联盟科技有限公司
6、中体数科（北京）体育发展有限公司
7、首都信息发展股份有限公司
8、航天神舟智慧系统技术有限公司
9、小诺V2 https://gitee.com/xiaonuobase/snowy
10、山东大小同屏科技有限公司
12、山东酸橙网络科技有限公司
12、桔子数字科技有限公司
13、成都新潮传媒集团股份有限公司
14、陕西汇每家信息科技有限公司(每一天便利店连锁)
15、江西云牛科技
16、广州彩讯数字技术有限公司
17、江苏誉鸣航智能科技有限公司
18、maku-boot https://gitee.com/makunet/maku-boot
19、北京大美星空科技有限公司

作者二维码 #

加作者二维码邀请进入官方群