• 0
  • 0
分享
  • Java 中 N+1 问题的集成测试——软件测试圈
  • quinn 2024-07-17 17:07:50 字数 8243 阅读 529 收藏 0

  N+1问题:N+1问题是指在使用关系型数据库时,在获取一组对象及其关联对象时,产生额外的数据库查询的问题。其中N表示要获取的主对象的数量,而在获取每个主对象的关联对象时,会产生额外的1次查询。

  N+1问题是很多项目中的通病。遗憾的是,直到数据量变得庞大时,我们才注意到它。不幸的是,当处理 N + 1 问题成为一项难以承受的任务时,代码可能会达到了一定规模。

  在这篇文章中,我们将开始关注以下几点问题:

  N + 1 问题的一个例子

  假设我们正在开发管理动物园的应用程序。在这种情况下,有两个核心实体:Zoo和Animal。请看下面的代码片段:

  @Entity
  @Table(name = "zoo")
  public class Zoo {
      @Id
      @GeneratedValue(strategy = IDENTITY)
      private Long id;
      private String name;
      @OneToMany(mappedBy = "zoo", cascade = PERSIST)
      private List<Animal> animals = new ArrayList<>();
  }
  @Entity
  @Table(name = "animal")
  public class Animal {
      @Id
      @GeneratedValue(strategy = IDENTITY)
      private Long id;
      @ManyToOne(fetch = LAZY)
      @JoinColumn(name = "zoo_id")
      private Zoo zoo;
      private String name;
  }

  现在我们想要检索所有现有的动物园及其动物。看看ZooService下面的代码。

  @Service
  @RequiredArgsConstructor
  public class ZooService {
      private final ZooRepository zooRepository;
      @Transactional(readOnly = true)
      public List<ZooResponse> findAllZoos() {
          final var zoos = zooRepository.findAll();
          return zoos.stream()
                     .map(ZooResponse::new)
                     .toList();
      }
  }

  此外,我们要检查一切是否顺利进行。简单的集成测试:

  @DataJpaTest
  @AutoConfigureTestDatabase(replace = NONE)
  @Transactional(propagation = NOT_SUPPORTED)
  @Testcontainers
  @Import(ZooService.class
  class ZooServiceTest {
      @Container
      static final PostgreSQLContainer<?> POSTGRES = new PostgreSQLContainer<>("postgres:13");
      @DynamicPropertySource
      static void setProperties(DynamicPropertyRegistry registry) {
          registry.add("spring.datasource.url", POSTGRES::getJdbcUrl);
          registry.add("spring.datasource.username", POSTGRES::getUsername);
          registry.add("spring.datasource.password", POSTGRES::getPassword);
      }
      @Autowired
      private ZooService zooService;
      @Autowired
      private ZooRepository zooRepository;
      @Test
      void shouldReturnAllZoos() {
          /* data initialization... */
          zooRepository.saveAll(List.of(zoo1, zoo2));
          final var allZoos = assertQueryCount(
              () -> zooService.findAllZoos(),
              ofSelects(1)
          );
          /* assertions... */
          assertThat(
              ...
          );
      }
  }

  测试成功通过。但是,如果记录 SQL 语句,会注意到以下几点:

  -- selecting all zoos

  select z1_0.id,z1_0.name from zoo z1_0

  -- selecting animals for the first zoo

  select a1_0.zoo_id,a1_0.id,a1_0.name from animal a1_0 where a1_0.zoo_id=?

  -- selecting animals for the second zoo

  select a1_0.zoo_id,a1_0.id,a1_0.name from animal a1_0 where a1_0.zoo_id=?

  如所见,我们select对每个 present 都有一个单独的查询Zoo。查询总数等于所选动物园的数量+1。因此,这是N+1问题。

  这可能会导致严重的性能损失。尤其是在大规模数据上。

  自动跟踪 N+1 问题

  当然,我们可以自行运行测试、查看日志和计算查询次数,以确定可行的性能问题。无论如何,这效率很低。。

  有一个非常高效的库,叫做datasource-proxy。它提供了一个方便的 API 来javax.sql.DataSource使用包含特定逻辑的代理来包装接口。例如,我们可以注册在查询执行之前和之后调用的回调。该库还包含开箱即用的解决方案来计算已执行的查询。我们将对其进行一些改动以满足我们的需要。

  查询计数服务

  首先,将库添加到依赖项中:

  implementation "net.ttddyy:datasource-proxy:1.8"

  现在创建QueryCountService. 它是保存当前已执行查询计数并允许您清理它的单例。请看下面的代码片段。

  @UtilityClass
  public class QueryCountService {
      static final SingleQueryCountHolder QUERY_COUNT_HOLDER = new SingleQueryCountHolder();
      public static void clear() {
          final var map = QUERY_COUNT_HOLDER.getQueryCountMap();
          map.putIfAbsent(keyName(map), new QueryCount());
      }
      public static QueryCount get() {
          final var map = QUERY_COUNT_HOLDER.getQueryCountMap();
          return ofNullable(map.get(keyName(map))).orElseThrow();
      }
      private static String keyName(Map<String, QueryCount> map) {
          if (map.size() == 1) {
              return map.entrySet()
                         .stream()
                         .findFirst()
                         .orElseThrow()
                         .getKey();
          }
          throw new IllegalArgumentException("Query counts map should consists of one key: " + map);
      }
  }

  在那种情况下,我们假设_DataSource_我们的应用程序中有一个。这就是_keyName_函数否则会抛出异常的原因。但是,代码不会因使用多个数据源而有太大差异。

  将SingleQueryCountHolder所有QueryCount对象存储在常规ConcurrentHashMap.

  相反,_ThreadQueryCountHolder_将值存储在_ThreadLocal_对象中。但是_SingleQueryCountHolder_对于我们的情况来说已经足够了。

  API 提供了两种方法。该get方法返回当前执行的查询数量,同时clear将计数设置为零。

  BeanPostProccessor 和 DataSource 代理

  现在我们需要注册QueryCountService以使其从 收集数据DataSource。在这种情况下,BeanPostProcessor 接口就派上用场了。请看下面的代码示例。

  @TestComponent
  public class DatasourceProxyBeanPostProcessor implements BeanPostProcessor {
      @Override
      public Object postProcessAfterInitialization(Object bean, String beanName) {
          if (bean instanceof DataSource dataSource) {
              return ProxyDataSourceBuilder.create(dataSource)
                         .countQuery(QUERY_COUNT_HOLDER)
                         .build();
          }
          return bean;
      }
  }

  我用注释标记类_@TestComponent_并将其放入_src/test_目录,因为我不需要对测试范围之外的查询进行计数。

  如您所见,这个想法很简单。如果一个 bean 是DataSource,则将其包裹起来ProxyDataSourceBuilder并将QUERY_COUNT_HOLDER值作为QueryCountStrategy.

  最后,我们要断言特定方法的已执行查询量。看看下面的代码实现:

  @UtilityClass
  public class QueryCountAssertions {
      @SneakyThrows
      public static <T> T assertQueryCount(Supplier<T> supplier, Expectation expectation) {
          QueryCountService.clear();
          final var result = supplier.get();
          final var queryCount = QueryCountService.get();
          assertAll(
              () -> {
                  if (expectation.selects >= 0) {
                      assertEquals(expectation.selects, queryCount.getSelect(), "Unexpected selects count");
                  }
              },
              () -> {
                  if (expectation.inserts >= 0) {
                      assertEquals(expectation.inserts, queryCount.getInsert(), "Unexpected inserts count");
                  }
              },
              () -> {
                  if (expectation.deletes >= 0) {
                      assertEquals(expectation.deletes, queryCount.getDelete(), "Unexpected deletes count");
                  }
              },
              () -> {
                  if (expectation.updates >= 0) {
                      assertEquals(expectation.updates, queryCount.getUpdate(), "Unexpected updates count");
                  }
              }
          );
          return result;
      }
  }

  该代码很简单:

  1. 将当前查询计数设置为零。

  2. 执行提供的 lambda。

  3. 将查询计数给定的Expectation对象。

  4. 如果一切顺利,返回执行结果。

  此外,您还注意到了一个附加条件。如果提供的计数类型小于零,则跳过断言。不关心其他查询计数时,这很方便。

  该类Expectation只是一个常规数据结构。看下面它的声明:

  @With
  @AllArgsConstructor
  @NoArgsConstructor
  public static class Expectation {
      private int selects = -1;
      private int inserts = -1;
      private int deletes = -1;
      private int updates = -1;
      public static Expectation ofSelects(int selects) {
          return new Expectation().withSelects(selects);
      }
      public static Expectation ofInserts(int inserts) {
          return new Expectation().withInserts(inserts);
      }
      public static Expectation ofDeletes(int deletes) {
          return new Expectation().withDeletes(deletes);
      }
      public static Expectation ofUpdates(int updates) {
          return new Expectation().withUpdates(updates);
      }
  }

  最后的例子

  让我们看看它是如何工作的。首先,我在之前的 N+1 问题案例中添加了查询断言。看下面的代码块:

  final var allZoos = assertQueryCount(
      () -> zooService.findAllZoos(),
      ofSelects(1)
  );

  不要忘记

  _DatasourceProxyBeanPostProcessor_在测试中作为 Spring bean 导入。

  如果我们重新运行测试,我们将得到下面的输出。

  Multiple Failures (1 failure)
      org.opentest4j.AssertionFailedError: Unexpected selects count ==> expected: <1> but was: <3>
  Expected :1
  Actual   :3

  所以,确实有效。我们设法自动跟踪 N+1 问题。是时候用 替换常规选择了JOIN FETCH。请看下面的代码片段。

  public interface ZooRepository extends JpaRepository<Zoo, Long> {
      @Query("FROM Zoo z LEFT JOIN FETCH z.animals")
      List<Zoo> findAllWithAnimalsJoined();
  }
  @Service
  @RequiredArgsConstructor
  public class ZooService {
      private final ZooRepository zooRepository;
      @Transactional(readOnly = true)
      public List<ZooResponse> findAllZoos() {
          final var zoos = zooRepository.findAllWithAnimalsJoined();
          return zoos.stream()
                     .map(ZooResponse::new)
                     .toList();
      }
  }

  让我们再次运行测试并查看结果:

1-1.png

  这意味着正确地跟踪了 N + 1 个问题。此外,如果查询数量等于预期数量,则它会成功通过。

  结论

  事实上,定期测试可以防止 N+1 问题。这是一个很好的机会,可以保护那些对性能至关重要的代码部分。


作者:MobotStone    

来源:http://www.51testing.com/html/52/n-7796652.html

  • 【留下美好印记】
    赞赏支持
登录 后发表评论
+ 关注

热门文章

    最新讲堂

      • 推荐阅读
      • 换一换
          •   一些想转行做软件测试的同学,想知道现在学完的同学的工资是多少,是否值得转行去学习,今天我就拿数据给大家分析一下软件测试到底值不值得去学习。  软件测试的好处  从数据可以看出,软件测试行业的平均工资在9K左右,刚培训完软件测试的学生也可以拿到平均6K,年份越长工资越高,行业领导者的平均工资在25K以上。其中,超过27.4%的员工拿到10-15K的工资。  软件测试招聘需求  看完福利,我们再来看看招聘需求。从数据可以看出,目前软件测试行业的招聘需求主要集中在超一线城市和一线城市。其中,深圳和上海的招聘需求最高,有超过16.6K个和14.7K个的招聘需求,所以建议想从事软件测试工作的同学选择...
            0 0 842
            分享
          • 每个开发都不想写文档。当你不想写接口文档时,可以通过安装插件在 IDEA 里实现自动同步,一边写代码一边同步接口文档给你的前端、测试同学。以下内容手把手教你怎么操作(这里仅面向使用 IDEA 编辑器、遵循 Java Spring 框架注释规范的同学):首先,你需要安装一个插件IDEA 插件市场里搜索 「Apifox Helper」,这是国内一个做 API 协作管理平台的厂商(Apifox)做的插件,可以非常方便自动生成接口文档并且同步到你的项目中。这个插件可以实现代码零入侵自动生产接口文档。IDEA 安装插件:打开 IDEA > Preferences(Settings) > Pl...
            0 0 2005
            分享
          •   应用场景  接口还没有开发好,现在测不了;测试系统有多个接口,测试环境没有配置好,还无法开展测试执行;这个功能到底哪里出错了,不好说,接口太多,要一个一个调试......  孤立的应用程序变得越来少了,做起API 的测试需要多方面协调,环境的配置、数据的准备、测试场景的设计以及提交缺陷时的出错信息的准确度等诸多因素都在影响着测试计划、测试进度、测试结果。  今天我们就学习搭建一个API Mock Server ,利用它来做API或功能方面的测试,从而使被测试对象功能独立出来,这样既可以在外部接口还没有完成时,就提早介入测试,争取测试时间,又可以使被测试对象简单...
            13 13 1698
            分享
          •   显示性能测试进度  前些天逛github发现了tqdm,他可以动态显示程序的执行进度。根据前面开发的功能,在运行性能时,如果并发用户和请求数很大,那么终端就处于执行状态,不会有任何信息输出,直到运行结果,结果才被打印出来。  > python3 kb.py https://wwww.baidu.com -u 10 -q 10   请求URL: https://wwww.baidu.com   用户数:10,循环次数: 10   ============== Running =...
            0 0 671
            分享
          • 1、引言在微服务最流行的年代,开发与测试是不可缺少的环节(这说的跟没说一样),至于开发的环节,我就不说了(说的好像我会似的…);来聊一聊测试环节中的接口测试(这是我擅长的)。2、参数传递方式2.1 定义及方式接口测试目的:    验证微服务对客户端或服务暴露的接口是否能够正常工作。主要方式:    构造并发送HTTP请求消息给微服务,然后接收并验证微服务回复的HTTP响应消息。2.2 Path Parameter(路径参数)    1、在HTTP中,URL是一个很基本的概念,...
            1 2 12286
            分享
      • 51testing软件测试圈微信