diff --git a/README.md b/README.md index 3b9b8c6..5c512f3 100644 --- a/README.md +++ b/README.md @@ -41,12 +41,13 @@ ### 进阶 1. [Bean映射工具之Apache BeanUtils VS Spring BeanUtils](./docs/advanced/Apache-BeanUtils-VS-SpringBean-Utils.md) -2. **[如何在 Spring/Spring Boot 中做参数校验？你需要了解的都在这里！](./docs/advanced/spring-bean-validation.md)** -3. [5分钟搞懂如何在Spring Boot中Schedule Tasks](./docs/advanced/SpringBoot-ScheduleTasks.md) -4. **[新手也能看懂的 Spring Boot 异步编程指南](./docs/advanced/springboot-async.md)** -5. [Spring Boot 整合 阿里云OSS 存储服务，快来免费搭建一个自己的图床](./docs/advanced/springboot-oss.md) -6. [超详细，新手都能看懂 ！使用Spring Boot+Dubbo 搭建一个分布式服务](./docs/advanced/springboot-dubbo.md) -7. [从零入门 ！Spring Security With JWT（含权限验证）](https://github.com/Snailclimb/spring-security-jwt-guide) +2. [5种常见Bean映射工具的性能比对](./docs/advanced/Performance-of-Java-Mapping-Frameworks.md) +3. **[如何在 Spring/Spring Boot 中做参数校验？你需要了解的都在这里！](./docs/advanced/spring-bean-validation.md)** +4. [5分钟搞懂如何在Spring Boot中Schedule Tasks](./docs/advanced/SpringBoot-ScheduleTasks.md) +5. **[新手也能看懂的 Spring Boot 异步编程指南](./docs/advanced/springboot-async.md)** +6. [Spring Boot 整合 阿里云OSS 存储服务，快来免费搭建一个自己的图床](./docs/advanced/springboot-oss.md) +7. [超详细，新手都能看懂 ！使用Spring Boot+Dubbo 搭建一个分布式服务](./docs/advanced/springboot-dubbo.md) +8. [从零入门 ！Spring Security With JWT（含权限验证）](https://github.com/Snailclimb/spring-security-jwt-guide) ## 说明 diff --git a/docs/advanced/Performance-of-Java-Mapping-Frameworks.md b/docs/advanced/Performance-of-Java-Mapping-Frameworks.md new file mode 100644 index 0000000..f5ee0be --- /dev/null +++ b/docs/advanced/Performance-of-Java-Mapping-Frameworks.md @@ -0,0 +1,438 @@ +> 本文由 JavaGuide 翻译自 https://www.baeldung.com/java-performance-mapping-frameworks 。转载请注明原文地址以及翻译作者。 + +## 1. 介绍 + +创建由多个层组成的大型 Java 应用程序需要使用多种领域模型，如持久化模型、领域模型或者所谓的 DTO。为不同的应用程序层使用多个模型将要求我们提供 bean 之间的映射方法。手动执行此操作可以快速创建大量样板代码并消耗大量时间。幸运的是，Java 有多个对象映射框架。在本教程中，我们将比较最流行的 Java 映射框架的性能。 + +> 综合日常使用情况和相关测试数据，个人感觉 MapStruct、ModelMapper 这两个 Bean 映射框架是最佳选择。 + +## 2. 常见 Bean 映射框架概览 + +### 2.1. Dozer + +Dozer 是一个映射框架，它使用递归将数据从一个对象复制到另一个对象。框架不仅能够在 bean 之间复制属性，还能够在不同类型之间自动转换。 + +要使用 Dozer 框架，我们需要添加这样的依赖到我们的项目: + +```xml + + net.sf.dozer + dozer + 5.5.1 + +``` + +更多关于 Dozer 的内容可以在官方文档中找到： http://dozer.sourceforge.net/documentation/gettingstarted.html ，或者你也可以阅读这篇文章：https://www.baeldung.com/dozer 。 + +### 2.2. Orika + +Orika 是一个 bean 到 bean 的映射框架，它递归地将数据从一个对象复制到另一个对象。 + +Orika 的工作原理与 Dozer 相似。两者之间的主要区别是 Orika 使用字节码生成。这允许以最小的开销生成更快的映射器。 + +要使用 Orika 框架，我们需要添加这样的依赖到我们的项目: + +```xml + + ma.glasnost.orika + orika-core + 1.5.2 + +``` + +更多关于 Orika 的内容可以在官方文档中找到：https://orika-mapper.github.io/orika-docs/，或者你也可以阅读这篇文章：https://www.baeldung.com/orika-mapping。 + +### 2.3. MapStruct + +MapStruct 是一个自动生成 bean mapper 类的代码生成器。MapStruct 还能够在不同的数据类型之间进行转换。Github 地址：https://github.com/mapstruct/mapstruct。 + +要使用 MapStruct 框架，我们需要添加这样的依赖到我们的项目: + +```xml + + org.mapstruct + mapstruct-processor + 1.2.0.Final + +``` + +更多关于 MapStruct 的内容可以在官方文档中找到：https://mapstruct.org/，或者你也可以阅读这篇文章：https://www.baeldung.com/mapstruct。 + +要使用 MapStruct 框架，我们需要添加这样的依赖到我们的项目: + +```xml + + org.mapstruct + mapstruct-processor + 1.2.0.Final + +``` + +### 2.4. ModelMapper + +ModelMapper 是一个旨在简化对象映射的框架，它根据约定确定对象之间的映射方式。它提供了类型安全的和重构安全的 API。 + +更多关于 ModelMapper 的内容可以在官方文档中找到：http://modelmapper.org/ 。 + +要使用 ModelMapper 框架，我们需要添加这样的依赖到我们的项目: + +```xml + + org.modelmapper + modelmapper + 1.1.0 + +``` + +### 2.5. JMapper + +JMapper 是一个映射框架，旨在提供易于使用的、高性能的 Java bean 之间的映射。该框架旨在使用注释和关系映射应用 DRY 原则。该框架允许不同的配置方式:基于注释、XML 或基于 api。 + +更多关于 JMapper 的内容可以在官方文档中找到：https://github.com/jmapper-framework/jmapper-core/wiki。 + +要使用 JMapper 框架，我们需要添加这样的依赖到我们的项目: + +```xml + + com.googlecode.jmapper-framework + jmapper-core + 1.6.0.1 + + +``` + +## 3.测试模型 + +为了能够正确地测试映射，我们需要有一个源和目标模型。我们已经创建了两个测试模型。 + +第一个是一个只有一个字符串字段的简单 POJO，它允许我们在更简单的情况下比较框架，并检查如果我们使用更复杂的 bean 是否会发生任何变化。 + +简单的源模型如下: + +```java +public class SourceCode { + String code; + // getter and setter +} + +``` + +它的目标也很相似: + +```java +public class DestinationCode { + String code; + // getter and setter +} +``` + +源 bean 的实际示例如下: + +```java +public class SourceOrder { + private String orderFinishDate; + private PaymentType paymentType; + private Discount discount; + private DeliveryData deliveryData; + private User orderingUser; + private List orderedProducts; + private Shop offeringShop; + private int orderId; + private OrderStatus status; + private LocalDate orderDate; + // standard getters and setters +} +``` + +目标类如下图所示: + +```java +public class Order { + private User orderingUser; + private List orderedProducts; + private OrderStatus orderStatus; + private LocalDate orderDate; + private LocalDate orderFinishDate; + private PaymentType paymentType; + private Discount discount; + private int shopId; + private DeliveryData deliveryData; + private Shop offeringShop; + // standard getters and setters +} +``` + +整个模型结构可以在这里找到:https://github.com/eugenp/tutorials/tree/master/performance-tests/src/main/java/com/baeldung/performancetests/model/source。 + +## 4. 转换器 + +为了简化测试设置的设计，我们创建了如下所示的转换器接口: + +```java +public interface Converter { + Order convert(SourceOrder sourceOrder); + DestinationCode convert(SourceCode sourceCode); +} +``` + +我们所有的自定义映射器都将实现这个接口。 + +### 4.1. OrikaConverter + +Orika 支持完整的 API 实现，这大大简化了 mapper 的创建: + +```java +public class OrikaConverter implements Converter{ + private MapperFacade mapperFacade; + + public OrikaConverter() { + MapperFactory mapperFactory = new DefaultMapperFactory + .Builder().build(); + + mapperFactory.classMap(Order.class, SourceOrder.class) + .field("orderStatus", "status").byDefault().register(); + mapperFacade = mapperFactory.getMapperFacade(); + } + + @Override + public Order convert(SourceOrder sourceOrder) { + return mapperFacade.map(sourceOrder, Order.class); + } + + @Override + public DestinationCode convert(SourceCode sourceCode) { + return mapperFacade.map(sourceCode, DestinationCode.class); + } +} +``` + +### 4.2. **DozerConverter** + +Dozer 需要 XML 映射文件，有以下几个部分: + +```xml + + + + com.baeldung.performancetests.model.source.SourceOrder + com.baeldung.performancetests.model.destination.Order + + status + orderStatus + + + + com.baeldung.performancetests.model.source.SourceCode + com.baeldung.performancetests.model.destination.DestinationCode + + +``` + +定义了 XML 映射后，我们可以从代码中使用它: + +```java +public class DozerConverter implements Converter { + private final Mapper mapper; + + public DozerConverter() { + DozerBeanMapper mapper = new DozerBeanMapper(); + mapper.addMapping( + DozerConverter.class.getResourceAsStream("/dozer-mapping.xml")); + this.mapper = mapper; + } + + @Override + public Order convert(SourceOrder sourceOrder) { + return mapper.map(sourceOrder,Order.class); + } + + @Override + public DestinationCode convert(SourceCode sourceCode) { + return mapper.map(sourceCode, DestinationCode.class); + } +} +``` + +### 4.3. MapStructConverter + +Map 结构的定义非常简单，因为它完全基于代码生成: + +```java +@Mapper +public interface MapStructConverter extends Converter { + MapStructConverter MAPPER = Mappers.getMapper(MapStructConverter.class); + + @Mapping(source = "status", target = "orderStatus") + @Override + Order convert(SourceOrder sourceOrder); + + @Override + DestinationCode convert(SourceCode sourceCode); +} +``` + +### 4.4. **JMapperConverter** + +JMapperConverter 需要做更多的工作。接口实现后: + +```java +public class JMapperConverter implements Converter { + JMapper realLifeMapper; + JMapper simpleMapper; + + public JMapperConverter() { + JMapperAPI api = new JMapperAPI() + .add(JMapperAPI.mappedClass(Order.class)); + realLifeMapper = new JMapper(Order.class, SourceOrder.class, api); + JMapperAPI simpleApi = new JMapperAPI() + .add(JMapperAPI.mappedClass(DestinationCode.class)); + simpleMapper = new JMapper( + DestinationCode.class, SourceCode.class, simpleApi); + } + + @Override + public Order convert(SourceOrder sourceOrder) { + return (Order) realLifeMapper.getDestination(sourceOrder); + } + + @Override + public DestinationCode convert(SourceCode sourceCode) { + return (DestinationCode) simpleMapper.getDestination(sourceCode); + } +} +``` + +我们还需要向目标类的每个字段添加`@JMap`注释。此外，JMapper 不能在 enum 类型之间转换，它需要我们创建自定义映射函数: + +```java +@JMapConversion(from = "paymentType", to = "paymentType") +public PaymentType conversion(com.baeldung.performancetests.model.source.PaymentType type) { + PaymentType paymentType = null; + switch(type) { + case CARD: + paymentType = PaymentType.CARD; + break; + + case CASH: + paymentType = PaymentType.CASH; + break; + + case TRANSFER: + paymentType = PaymentType.TRANSFER; + break; + } + return paymentType; +} +``` + +### 4.5. **ModelMapperConverter** + +ModelMapperConverter 只需要提供我们想要映射的类: + +```java +public class ModelMapperConverter implements Converter { + private ModelMapper modelMapper; + + public ModelMapperConverter() { + modelMapper = new ModelMapper(); + } + + @Override + public Order convert(SourceOrder sourceOrder) { + return modelMapper.map(sourceOrder, Order.class); + } + + @Override + public DestinationCode convert(SourceCode sourceCode) { + return modelMapper.map(sourceCode, DestinationCode.class); + } +} + +``` + +## 5. 简单的模型测试 + +对于性能测试，我们可以使用 Java Microbenchmark Harness，关于如何使用它的更多信息可以在 这篇文章：https://www.baeldung.com/java-microbenchmark-harness 中找到。 + +我们为每个转换器创建了一个单独的基准测试，并将基准测试模式指定为 Mode.All。 + +### 5.1. 平均时间 + +对于平均运行时间，JMH 返回以下结果(越少越好): + +![AverageTime](https://my-blog-to-use.oss-cn-beijing.aliyuncs.com/2019-7/AVGTSimple.png) + +这个基准测试清楚地表明，MapStruct 和 JMapper 都有最佳的平均工作时间。 + +### 5.2. 吞吐量 + +在这种模式下，基准测试返回每秒的操作数。我们收到以下结果(越多越好): + +![Throughput](https://my-blog-to-use.oss-cn-beijing.aliyuncs.com/2019-7/THRPTRealLife2.png) + +在吞吐量模式中，MapStruct 是测试框架中最快的，JMapper 紧随其后。 + +### 5.3. **SingleShotTime** + +这种模式允许测量单个操作从开始到结束的时间。基准给出了以下结果(越少越好): + +![SingleShotTime](https://my-blog-to-use.oss-cn-beijing.aliyuncs.com/2019-7/SSTSimple.png) + +这里，我们看到 JMapper 返回的结果比 MapStruct 好得多。 + +### 5.4. **采样时间** + +这种模式允许对每个操作的时间进行采样。三个不同百分位数的结果如下: + +![SampleTime](https://my-blog-to-use.oss-cn-beijing.aliyuncs.com/2019-7/SampleTimeSimple.png) + +所有的基准测试都表明，根据场景的不同，MapStruct 和 JMapper 都是不错的选择，尽管 MapStruct 对 SingleShotTime 给出的结果要差得多。 + +## 6. 真实模型测试 + +对于性能测试，我们可以使用 Java Microbenchmark Harness，关于如何使用它的更多信息可以在 这篇文章：https://www.baeldung.com/java-microbenchmark-harness 中找到。 + +我们为每个转换器创建了一个单独的基准测试，并将基准测试模式指定为 Mode.All。 + +### 6.1. 平均时间 + +JMH 返回以下平均运行时间结果（越少越好）： + +![平均时间](https://my-blog-to-use.oss-cn-beijing.aliyuncs.com/2019-7/AVGTRealLife.png) + +该基准清楚地表明，MapStruct 和 JMapper 均具有最佳的平均工作时间。 + +### 6.2. 吞吐量 + +在这种模式下，基准测试返回每秒的操作数。我们收到以下结果(越多越好): + +![](https://my-blog-to-use.oss-cn-beijing.aliyuncs.com/2019-7/THRPTRealLife.png) + +在吞吐量模式中，MapStruct 是测试框架中最快的，JMapper 紧随其后。 + +### 6.3. **SingleShotTime** + +这种模式允许测量单个操作从开始到结束的时间。基准给出了以下结果(越少越好): + +![](https://my-blog-to-use.oss-cn-beijing.aliyuncs.com/2019-7/SSTRealLife.png) + +### 6.4. **采样时间** + +这种模式允许对每个操作的时间进行采样。三个不同百分位数的结果如下: + +![SampleTime](https://my-blog-to-use.oss-cn-beijing.aliyuncs.com/2019-7/SampleTimeSimple.png) + +尽管简单示例和实际示例的确切结果明显不同，但是它们的趋势相同。在哪种算法最快和哪种算法最慢方面，两个示例都给出了相似的结果。 + +### 6.5. 结论 + +根据我们在本节中执行的真实模型测试，我们可以看出，最佳性能显然属于 MapStruct。在相同的测试中，我们看到 Dozer 始终位于结果表的底部。 + +## 7. **总结** + +在这篇文章中，我们已经进行了五个流行的 Java Bean 映射框架性能测试：ModelMapper **，** MapStruct **，** Orika ，Dozer， JMapper。 + +示例代码地址：https://github.com/eugenp/tutorials/tree/master/performance-tests。