本文不是一个吹嘘的文章,不会讲很多高深的架构,相反,会讲解很多基础的问题和写法问题,如果读者自认为基础问题和写法问题都是不是问题,那请忽略这篇文章,节省出时间去做一些有意义的事情。
开发工具
不知道有多少“老”程序员还在是用 Eclipse,这些程序员们要不就是因循守旧,要不就是根本就不知道其他好的开发工具的存在,Eclipse 吃内存卡顿的现象,以及各种偶然莫名异常的出现,都告知我们是时候寻找新的开发工具了。
更换 IDE
根本就不想多解释要换什么样的 IDE,如果你想成为一个优秀的 Java 程序员,请更换 IntelliJ IDEA。使用 IDEA 的好处,请搜索谷歌。
别告诉我快捷键不好用
更换 IDE 不在我本文的重点内容中,所以不想用太多的篇幅去写为什么更换IDE。在这里,我只能告诉你,更换 IDE 只为了更好、更快的写好 Java 代码。原因略。
别告诉我快捷键不好用,请尝试新事物。
Bean
Bean 使我们使用最多的模型之一,我将以大篇幅去讲解 Bean,希望读者好好体会。
Domain 包名
根据很多 Java 程序员的”经验”来看,一个数据库表则对应着一个 Domain 对象,所以很多程序员在写代码时,包名则使用:com.xxx.domain ,这样写好像已经成为了行业的一种约束,数据库映射对象就应该是 Domain。但是你错了,Domain 是一个领域对象,往往我们在做传统 Java 软件 Web 开发中,这些 Domain 都是贫血模型,是没有行为的,或是没有足够的领域模型的行为的,所以,以这个理论来讲,这些 Domain 都应该是一个普通的 entity 对象,并非领域对象,所以请把包名改为:com.xxx.entity。
如果你还不理解我说的话,请看一下 Vaughn Vernon 出的一本叫做IMPLEMENTING DOMAIN-DRIVEN DESIGN(《实现领域驱动设计》)这本书,书中讲解了贫血模型与领域模型的区别,相信你会受益匪浅。
DTO
数据传输我们应该使用 DTO 对象作为传输对象,这是我们所约定的,因为很长时间我一直都在做移动端 API 设计的工作,有很多人告诉我,他们认为只有给手机端传输数据的时候(input or output),这些对象成为 DTO 对象。请注意!这种理解是错误的,只要适用于网络传输的对象,我们都认为他们可以当做是 DTO 对象,比如电商平台中,用户进行下单,下单后的数据,订单会发到 OMS 或者 ERP 系统,这些对接的返回值以及入参也叫 DTO 对象。
我们约定某对象如果是 DTO 对象,就将名称改为 XXDTO,比如订单下发 OMS:OMSOrderInputDTO。
DTO 转化
正如我们所知,DTO 为系统与外界交互的模型对象,那么肯定会有一个步骤是将 DTO 对象转化为 BO 对象或者是普通的 entity 对象,让 service 层去处理。
场景
比如添加会员操作,有于用于演示,我只考虑用户的一些简单数据,当后台管理员点击添加用户时,只需要传过来用户的姓名和年龄就可以了,后端接收到数据后,将添加创建时间和更新时间和默认密码三个字段,然后保存数据库。
@RestControllerpublic class UserApi { @Autowired private UserService userService; @PostMapping public User addUser(UserInputDTO userInputDTO){ User user = new User(); user.setUsername(userInputDTO.getUsername()); user.setAge(userInputDTO.getAge()); return userService.addUser(user); }}
我们只关注一下上述代码中的转化代码,其他内容请忽略:
User user = new User();user.setUsername(userInputDTO.getUsername());user.setAge(userInputDTO.getAge());
请使用工具
上边的代码,从逻辑上讲,是没有问题的,只是这种写法让我很厌烦,例子中只有两个字段,如果有 20 个字段,我们要如何做呢?一个一个进行 set 数据吗?当然,如果你这么做了,肯定不会有什么问题,但是,这肯定不是一个最优的做法。
网上有很多工具,支持浅拷贝或深拷贝的 Utils。举个例子,我们可以使用
org.springframework.beans.BeanUtils#copyProperties 对代码进行重构和优化:
@PostMappingpublic User addUser(UserInputDTO userInputDTO){ User user = new User(); BeanUtils.copyProperties(userInputDTO,user); return userService.addUser(user);}
BeanUtils.copyProperties 是一个浅拷贝方法,复制属性时,我们只需要把 DTO 对象和要转化的对象两个的属性值设置为一样的名称,并且保证一样的类型就可以了。如果你在做 DTO 转化的时候一直使用 set 进行属性赋值,那么请尝试这种方式简化代码,让代码更加清晰!
转化的语义
上边的转化过程,读者看后肯定觉得优雅很多,但是我们再写 Java 代码时,更多的需要考虑语义的操作,再看上边的代码:
@PostMapping public User addUser(UserInputDTO userInputDTO){ User user = convertFor(userInputDTO); return userService.addUser(user); } private User convertFor(UserInputDTO userInputDTO){ User user = new User(); BeanUtils.copyProperties(userInputDTO,user); return user; }
虽然这段代码很好地简化和优化了代码,但是它的语义是有问题的,我们需要体现一个转化过程才好,所以代码改成如下:
User user = convertFor(userInputDTO);return userService.addUser(user);
这是一个更好的语义写法,虽然麻烦了些,但是可读性大大增加了,在写代码时,我们应该尽量把语义层次差不多地放到一个方法中,比如:
User user = convertFor(userInputDTO);return userService.addUser(user);
这两段代码都没有暴露实现,都是在讲如何在同一个方法中,做一组相同层次的语义操作,而不是暴露具体的实现。
如上所述,是一种重构方式,读者可以参考Martin Fowler 的Refactoring Imporving the Design of Existing Code(《重构——改善既有代码的设计》)这本书中的 Extract Method 重构方式。
抽象接口定义
当实际工作中,完成了几个 API 的 DTO 转化时,我们会发现,这样的操作有很多很多,那么应该定义好一个接口,让所有这样的操作都有规则的进行。
如果接口被定义以后,那么 convertFor 这个方法的语义将产生变化,它将是一个实现类。
看一下抽象后的接口:
public class UserInputDTOConvert implements DTOConvert {@Overridepublic User convert(UserInputDTO userInputDTO) {User user = new User();BeanUtils.copyProperties(userInputDTO,user);return user;}}
虽然这个接口很简单,但是这里告诉我们一个事情,要去使用泛型,如果你是一个优秀的 Java 程序员,请为你想做的抽象接口,做好泛型吧。
我们再来看接口实现:
public class UserInputDTOConvert implements DTOConvert {@Overridepublic User convert(UserInputDTO userInputDTO) {User user = new User();BeanUtils.copyProperties(userInputDTO,user);return user;}}
我们这样重构后,我们发现现在的代码是如此的简洁,并且那么的规范:
@PostMappingpublic UserOutputDTO addUser(UserInputDTO userInputDTO){ User user = new UserInputDTOConvert().convert(userInputDTO); User saveUserResult = userService.addUser(user); UserOutputDTO result = new UserOutDTOConvert().convertToUser(saveUserResult); return result;}
Review Code
如果你是一个优秀的 Java 程序员,我相信你应该和我一样,已经数次重复 Review 过自己的代码很多次了。
我们再看这个保存用户的例子,你将发现,API 中返回值是有些问题的,问题就在于不应该直接返回 User 实体,因为如果这样的话,就暴露了太多实体相关的信息,这样的返回值是不安全的,所以我们更应该返回一个 DT