一个注解让你的项目减少30%SQL代码量

今天给大家介绍一个很好用的开源项目:easy_trans,它能让你的项目减少30%的SQL代码量,接下来让我们进一步了解它。

什么是Easy_Trans

Easy Trans是一款用于做数据翻译的代码辅助插件,利用MyBatis Plus/JPA/BeetlSQL 等ORM框架的能力自动查表,让开发者可以快速的把ID/字典码 翻译为前端需要展示的数据。

一个注解让你的项目减少30%SQL代码量_第1张图片

easy trans的优点

功能多样

  1. 缓存支持

  2. 跨微服务翻译支持(User和Order 是2个不同微服务,order里面有userId 需要userName)

  3. 国际化支持

  4. 多种ORM框架适配

  5. 多数据源支持

  6. 集合支持(userIds [1,2,3] 翻译为张三,李四,王五)

  7. 反向翻译支持 男->gender 0 张三->user id id 陕西分公司 财务部 -> org_id 1

适用多种场景

  1. 我拥有一个ID,但需要向客户展示他的职位/姓名,但又不想手动执行表关联查询。

  2. 我有一个字典码"sex"和对应的字典值0,我希望将其翻译为"男",以便展示给客户。

  3. 我有一组用户ID,例如1、2、3,我希望将它们展示为"张三"、"李四"、"王五",供客户查看。

  4. 我的枚举中包含一个"title"字段,我希望向前端展示该字段的值,以供客户查看。

  5. 我拥有一个唯一键(例如手机号码、身份证号码),但需要向客户展示他们的职位/姓名,而又不想手动执行表关联查询。

配置简单

对于springboot项目,只需要引入 easy-trans 的starter



    com.fhs-opensource
    easy-trans-spring-boot-starter
    2.2.1-M1

然后引入项目中对应的orm框架的扩展,以mybatisPlus为例


    com.fhs-opensource
    easy-trans-mybatis-plus-extend
    2.2.1-M1

然后 yml 配置

# 翻译配置
easy-trans:
  # 平铺模式
  is-enable-tile: true
  # 开启redis支持
  is-enable-redis: true
  # 开启responseBody 全局拦截后自动翻译
  is-enable-global: true
  # 字典缓存是否放到redis中 做二级缓存,微服务模式推荐开启
  dict-use-redis: true
  db-type: mysql

灵活易用

easy trans 支持五种类型

1、字典翻译(TransType.DICTIONARY)

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

2、简单翻译(TransType.SIMPLE)

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

3、跨微服务翻译(TransType.RPC)

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

4、AutoTrans(TransType.AUTO)

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

5、枚举翻译(TransType.ENUM)

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

具体可以看示例项目:

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

小结

Easy-Trans 官方文档:

http://easy-trans.fhs-opensource.top/components/readme.html

今天就介绍到这里了,有兴趣的小伙伴们,可以去官方文档进一步了解哦~

你可能感兴趣的:(sql,mybatis,java,spring,boot,数据库)