0

0

Spring Boot 微服务控制器测试:处理外部服务依赖与JWT认证的策略

花韻仙語

花韻仙語

发布时间:2025-11-26 14:31:38

|

601人浏览过

|

来源于php中文网

原创

Spring Boot 微服务控制器测试:处理外部服务依赖与JWT认证的策略

针对spring boot微服务控制器测试中,因mockmvc尝试调用外部服务(如认证服务)而导致404的问题,本教程提供两种核心解决方案:一是通过模拟外部服务客户端来隔离依赖,二是在测试环境中直接生成或提供有效的jwt令牌,从而避免实际的服务调用,确保测试的独立性和效率。

理解问题核心:mockMvc的边界与外部服务调用

在Spring Boot微服务架构中,进行控制器(Controller)测试时,我们通常使用MockMvc来模拟HTTP请求,从而测试控制器层的行为。然而,MockMvc的设计初衷是用于测试当前应用上下文中的控制器端点。当测试代码中的辅助方法(例如,用于获取JWT令牌的getJWTTokenForRoleUser)尝试通过mockMvc.perform()调用一个属于另一个微服务(如认证服务)的API端点时,当前应用上下文无法找到对应的处理器,因此会返回HTTP 404 Not Found错误。

原始代码中的getJWTTokenForRoleUser方法试图通过以下方式获取JWT:

// 原始的 getJWTTokenForRoleUser 方法片段
MvcResult result = mockMvc.perform(MockMvcRequestBuilders.post("/authenticate/login")
                        .contentType(MediaType.APPLICATION_JSON)
                        .content(asJsonString(loginRequest)))
                .andDo(MockMvcResultHandlers.print())
                .andExpect(MockMvcResultMatchers.status().isOk())
                .andReturn();

这里的/authenticate/login是认证服务的端点,而非订单服务的端点。因此,当订单服务的OrderControllerTest执行此段代码时,mockMvc自然无法找到并处理此请求,导致404。此外,即使能够成功调用外部服务,在单元/集成测试中进行真实的跨服务调用也是不推荐的,因为它会引入外部依赖,增加测试的复杂性和不稳定性。

解决方案策略:隔离与模拟

为了解决这个问题,我们需要在测试中隔离对外部服务的依赖。主要有两种策略:

策略一:模拟外部服务客户端

如果你的服务内部通过特定的客户端(如RestTemplate、WebClient或Feign Client)与外部服务进行通信,那么在测试中模拟这些客户端的行为是最佳实践。

适用场景:当你的服务逻辑依赖于从外部服务获取的真实数据或响应时,例如,订单服务需要调用认证服务来验证用户凭据并获取JWT。

实现方式:使用Spring Test提供的@MockBean或@SpyBean注解来模拟或部分模拟这些客户端组件。通过Mockito库定义这些模拟对象的行为,使其在特定输入下返回预期的结果。

示例:假设订单服务有一个AuthServiceProxy组件负责与认证服务通信。

// 假设订单服务中存在一个AuthServiceProxy类
@Service
public class AuthServiceProxy {
    private final RestTemplate restTemplate;
    // ... 其他依赖

    public AuthServiceProxy(RestTemplate restTemplate) {
        this.restTemplate = restTemplate;
    }

    public JWTResponse login(LoginRequest loginRequest) {
        // 实际调用认证服务的逻辑
        return restTemplate.postForObject("http://AUTH-SERVICE/authenticate/login", loginRequest, JWTResponse.class);
    }
}

在OrderControllerTest中,我们可以这样模拟它:

import org.junit.jupiter.api.Test;
import org.mockito.Mockito;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest;
import org.springframework.boot.test.mock.mockito.MockBean;
import org.springframework.http.MediaType;
import org.springframework.test.web.servlet.MockMvc;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.post;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;

@WebMvcTest(OrderController.class) // 假设测试OrderController
public class OrderControllerTest {

    @Autowired
    private MockMvc mockMvc;

    @MockBean // 模拟AuthServiceProxy
    private AuthServiceProxy authServiceProxy;

    // ... 其他依赖和工具方法

    @Test
    void test_When_placeOrder_DoPayment_Success_WithMockedAuthService() throws Exception {
        // 1. 模拟AuthServiceProxy的行为
        JWTResponse mockJwtResponse = new JWTResponse("mocked_jwt_token_for_user", "User", List.of("ROLE_USER"));
        Mockito.when(authServiceProxy.login(Mockito.any(LoginRequest.class)))
               .thenReturn(mockJwtResponse);

        // 2. 使用模拟的JWT令牌进行订单放置请求
        OrderRequest orderRequest = getMockOrderRequest();
        String jwt = mockJwtResponse.getToken(); // 从模拟响应中获取令牌

        mockMvc.perform(post("/order/placeorder")
                        .contentType(MediaType.APPLICATION_JSON_VALUE)
                        .header("Authorization", "Bearer " + jwt)
                        .content(objectMapper.writeValueAsString(orderRequest)))
                .andExpect(status().isOk());

        // ... 后续断言
    }

    // 辅助方法,如果仍需要生成LoginRequest
    private LoginRequest getMockLoginRequest() {
        return new LoginRequest("User", "User");
    }
}

策略二:直接生成或提供测试用JWT令牌

对于控制器测试,如果核心关注点在于当前服务的业务逻辑,而非认证服务本身的令牌生成机制,那么直接在测试环境中生成一个有效的JWT令牌,并将其用于请求头,是最简洁高效的方法。这避免了对外部服务或其模拟客户端的依赖。

适用场景:大多数控制器层面的集成测试,你只需要一个有效的JWT来通过安全过滤器,而不需要模拟认证服务的完整流程。

Packify
Packify

Packify 是一个创新的AI包装设计工具

下载

优势:测试更轻量、独立,执行速度更快,且不易受外部服务接口变化的影响。同时,可以避免原始问题中提到的“过期令牌”问题,因为每次测试都可以生成一个新鲜的有效令牌。

实现方式

  1. 在测试中直接生成JWT:利用jjwt库(通常认证服务也使用此库)和与认证服务相同的密钥及过期策略,在测试代码中生成一个有效的JWT。
  2. 重构getJWTTokenForRoleUser方法:将原有的mockMvc调用替换为JWT生成逻辑。

代码实践:生成测试JWT令牌

首先,确保你的测试环境中可以访问到用于签名JWT的密钥(jwtSecret)和过期时间(jwtExpirationMs)。这些通常从application.properties或application.yml中加载。

1. JWT生成工具类或辅助方法

在测试类中或一个专门的测试工具类中,创建一个辅助方法来生成JWT。

import io.jsonwebtoken.Jwts;
import io.jsonwebtoken.SignatureAlgorithm;
import io.jsonwebtoken.security.Keys; // 导入Keys用于生成安全的密钥
import org.springframework.beans.factory.annotation.Value;
import org.springframework.security.core.GrantedAuthority;
import org.springframework.security.core.authority.SimpleGrantedAuthority;
import java.util.Collections;
import java.util.Date;
import java.util.List;
import java.util.stream.Collectors;
import javax.crypto.SecretKey; // 使用javax.crypto.SecretKey

// 假设在OrderControllerTest中
public class OrderControllerTest {

    // 注入或定义JWT密钥和过期时间,确保与Auth Service一致
    // 注意:在实际项目中,测试密钥应与生产密钥隔离,或通过测试配置提供
    @Value("${application.jwt.secret}") // 从application-test.properties加载
    private String jwtSecret;

    @Value("${application.jwt.expiration-ms}") // 从application-test.properties加载
    private long jwtExpirationMs;

    // ... 其他注入和测试方法

    /**
     * 为测试目的生成一个有效的JWT令牌
     * @param username 用户名
     * @param roles 用户的角色列表
     * @return 生成的JWT字符串
     */
    private String generateTestJwtToken(String username, List roles) {
        // 将字符串密钥转换为SecretKey
        SecretKey key = Keys.hmacShaKeyFor(jwtSecret.getBytes());

        List authorities = roles.stream()
                .map(SimpleGrantedAuthority::new)
                .collect(Collectors.toList());

        return Jwts.builder()
                .setSubject(username)
                .claim("roles", authorities) // 根据你的Auth Service如何存储角色信息来调整
                .setIssuedAt(new Date())
                .setExpiration(new Date((new Date()).getTime() + jwtExpirationMs))
                .signWith(key, SignatureAlgorithm.HS512) // 使用HS512算法
                .compact();
    }

    // 重构后的 getJWTTokenForRoleUser 方法
    private String getJWTTokenForRoleUser() {
        // 直接生成一个带有"User"角色和用户名的JWT
        return generateTestJwtToken("User", Collections.singletonList("ROLE_USER"));
    }

    @Test
    @DisplayName("Place Order -- Success Scenario")
    @WithMockUser(username = "User", authorities = { "ROLE_USER" }) // 此注解模拟了SecurityContext,但JWT仍需手动添加到Header
    void test_When_placeOrder_DoPayment_Success() throws Exception {

        OrderRequest orderRequest = getMockOrderRequest();
        String jwt = getJWTTokenForRoleUser(); // 现在这里直接生成JWT

        mockMvc.perform(MockMvcRequestBuilders.post("/order/placeorder")
                        .contentType(MediaType.APPLICATION_JSON_VALUE)
                        .header("Authorization", "Bearer " + jwt) // 使用生成的JWT
                        .content(objectMapper.writeValueAsString(orderRequest)))
                .andExpect(MockMvcResultMatchers.status().isOk())
                .andReturn();

        // ... 后续断言
    }
}

2. 配置JWT密钥和过期时间

为了让测试能够正确生成JWT,你需要在测试专用的配置文件(例如src/test/resources/application-test.properties或application.yml)中配置与认证服务一致的jwtSecret和jwtExpirationMs。

# src/test/resources/application-test.properties
application.jwt.secret=yourVerySecureTestSecretKeyForJWTGenerationThatIsAtLeast256BitsLong
application.jwt.expiration-ms=3600000 # 1小时,或根据需要设置

3. 关于JwtUtils的利用

原始问题中提到了JwtUtils在订单服务中用于解析令牌。如果你想在测试中验证生成的令牌是否能被JwtUtils正确解析,你可以注入JwtUtils并在测试中调用其解析方法进行断言。但对于控制器测试,主要目标是确保请求能通过安全过滤器并到达控制器。

注意事项与最佳实践

  1. 测试隔离性:始终追求测试的隔离性。单元测试应避免任何外部依赖,集成测试应尽量通过模拟或内存数据库来减少真实外部依赖。
  2. 密钥管理:在测试环境中使用的JWT密钥应与生产环境的密钥不同,以避免安全风险。确保测试密钥足够安全且只用于测试目的。
  3. 测试粒度
    • 直接生成JWT:适用于控制器测试,当你的重点是测试当前服务的业务逻辑,且只需要一个有效的令牌来通过安全层时。这是最轻量和高效的方法。
    • 模拟外部服务客户端:适用于更接近集成测试的场景,当你的服务确实需要与外部服务进行交互,并且你希望测试这种交互逻辑

相关专题

更多
spring框架介绍
spring框架介绍

本专题整合了spring框架相关内容,想了解更多详细内容,请阅读专题下面的文章。

102

2025.08.06

spring boot框架优点
spring boot框架优点

spring boot框架的优点有简化配置、快速开发、内嵌服务器、微服务支持、自动化测试和生态系统支持。本专题为大家提供spring boot相关的文章、下载、课程内容,供大家免费下载体验。

135

2023.09.05

spring框架有哪些
spring框架有哪些

spring框架有Spring Core、Spring MVC、Spring Data、Spring Security、Spring AOP和Spring Boot。详细介绍:1、Spring Core,通过将对象的创建和依赖关系的管理交给容器来实现,从而降低了组件之间的耦合度;2、Spring MVC,提供基于模型-视图-控制器的架构,用于开发灵活和可扩展的Web应用程序等。

389

2023.10.12

Java Spring Boot开发
Java Spring Boot开发

本专题围绕 Java 主流开发框架 Spring Boot 展开,系统讲解依赖注入、配置管理、数据访问、RESTful API、微服务架构与安全认证等核心知识,并通过电商平台、博客系统与企业管理系统等项目实战,帮助学员掌握使用 Spring Boot 快速开发高效、稳定的企业级应用。

68

2025.08.19

Java Spring Boot 4更新教程_Java Spring Boot 4有哪些新特性
Java Spring Boot 4更新教程_Java Spring Boot 4有哪些新特性

Spring Boot 是一个基于 Spring 框架的 Java 开发框架,它通过 约定优于配置的原则,大幅简化了 Spring 应用的初始搭建、配置和开发过程,让开发者可以快速构建独立的、生产级别的 Spring 应用,无需繁琐的样板配置,通常集成嵌入式服务器(如 Tomcat),提供“开箱即用”的体验,是构建微服务和 Web 应用的流行工具。

31

2025.12.22

Java Spring Boot 微服务实战
Java Spring Boot 微服务实战

本专题深入讲解 Java Spring Boot 在微服务架构中的应用,内容涵盖服务注册与发现、REST API开发、配置中心、负载均衡、熔断与限流、日志与监控。通过实际项目案例(如电商订单系统),帮助开发者掌握 从单体应用迁移到高可用微服务系统的完整流程与实战能力。

113

2025.12.24

硬盘接口类型介绍
硬盘接口类型介绍

硬盘接口类型有IDE、SATA、SCSI、Fibre Channel、USB、eSATA、mSATA、PCIe等等。详细介绍:1、IDE接口是一种并行接口,主要用于连接硬盘和光驱等设备,它主要有两种类型:ATA和ATAPI,IDE接口已经逐渐被SATA接口;2、SATA接口是一种串行接口,相较于IDE接口,它具有更高的传输速度、更低的功耗和更小的体积;3、SCSI接口等等。

1012

2023.10.19

PHP接口编写教程
PHP接口编写教程

本专题整合了PHP接口编写教程,阅读专题下面的文章了解更多详细内容。

60

2025.10.17

Java 项目构建与依赖管理(Maven / Gradle)
Java 项目构建与依赖管理(Maven / Gradle)

本专题系统讲解 Java 项目构建与依赖管理的完整体系,重点覆盖 Maven 与 Gradle 的核心概念、项目生命周期、依赖冲突解决、多模块项目管理、构建加速与版本发布规范。通过真实项目结构示例,帮助学习者掌握 从零搭建、维护到发布 Java 工程的标准化流程,提升在实际团队开发中的工程能力与协作效率。

4

2026.01.12

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Kotlin 教程
Kotlin 教程

共23课时 | 2.4万人学习

C# 教程
C# 教程

共94课时 | 6.5万人学习

Java 教程
Java 教程

共578课时 | 45.1万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号