首页 > Java > java教程 > 正文

使用 Spring Boot 测试 API Key 认证

聖光之護
发布: 2025-07-09 17:44:14
原创
547人浏览过

使用 spring boot 测试 api key 认证

本文介绍了如何在 Spring Boot 应用中测试基于 API Key 的认证机制。通过在测试请求中添加正确的 API Key Header,可以模拟真实场景,确保 API Key 认证的正确性和有效性,从而保证接口的安全性和可靠性。

在 Spring Boot 应用中,API Key 认证是一种常见的安全机制,用于保护 API 接口免受未经授权的访问。为了确保 API Key 认证的正确性,我们需要编写相应的测试用例。本文将介绍如何使用 MockMvc 在 Spring Boot 测试中模拟 API Key 认证。

假设我们有一个 Spring Boot 应用,其中一个端点 /validate 需要通过 API Key 认证才能访问。认证逻辑通过自定义的 AuthFilter 实现,该过滤器会检查请求头中是否存在名为 API_KEY 的 Header,并验证其值是否与预定义的 API Key 值匹配。

以下是一个简单的 AuthConfiguration 示例:

@Configuration
@EnableWebSecurity
@Order(1)
public class AuthConfiguration {
    public static final String API_KEY_VALUE = "skrdgvsnelrkv";
    public static final String API_KEY_HEADER = "API_KEY";

    @Value(API_KEY_HEADER)
    private String principalRequestHeader;

    @Value(API_KEY_VALUE)
    private String principalRequestValue;

    @Bean
    public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
        AuthFilter apiKeyFilter = new AuthFilter(principalRequestHeader);
        apiKeyFilter.setAuthenticationManager(new AuthenticationManager() {

            @Override
            public Authentication authenticate(Authentication authentication)
                throws AuthenticationException {
                String principal = (String) authentication.getPrincipal();
                if (!principalRequestValue.equals(principal)) {
                    throw new BadCredentialsException(
                        "The API key was not found or not the expected value."
                    );
                }
                authentication.setAuthenticated(true);
                return authentication;
            }
        });
        http.antMatcher(Endpoints.VALIDATE)
            .csrf()
            .disable()
            .sessionManagement()
            .sessionCreationPolicy(SessionCreationPolicy.STATELESS)
            .and()
            .addFilter(apiKeyFilter)
            .authorizeRequests()
            .anyRequest()
            .authenticated();

        return http.build();
    }
}
登录后复制

在没有添加 API Key Header 的情况下,直接调用 /validate 端点会导致 403 Forbidden 错误。

为了解决这个问题,我们需要在测试请求中添加正确的 API Key Header。可以使用 MockMvcRequestBuilders 的 header() 方法来添加 Header。

白瓜面试
白瓜面试

白瓜面试 - AI面试助手,辅助笔试面试神器

白瓜面试 40
查看详情 白瓜面试

以下是一个更新后的测试用例示例:

import org.springframework.test.web.servlet.request.MockMvcRequestBuilders;

@AutoConfigureTestEntityManager
@SpringBootTest
@ContextConfiguration(classes = { TestContext.class })
@TestPropertySource(properties = { "spring.main.allow-bean-definition-overriding=true" })
@AutoConfigureMockMvc
class ControllerTest {
    @Autowired
    private MockMvc mockMvc;

    @Test
    void callingValidateEndpointWithValidFileShouldReturnResponseWithStatusOk()
        throws Exception {
        MockMultipartFile file =
            MockMultipathFileBuilder.buildFromFilePath(TestFiles.VALID_FILE);

        mockMvc.perform(
            MockMvcRequestBuilders.multipart(Endpoints.VALIDATE)
                .file(file)
                .header(AuthConfiguration.API_KEY_HEADER, AuthConfiguration.API_KEY_VALUE)
        ).andExpect(status().isOk());
    }
}
登录后复制

在上面的代码中,我们使用 header(AuthConfiguration.API_KEY_HEADER, AuthConfiguration.API_KEY_VALUE) 方法将 API Key Header 添加到请求中。AuthConfiguration.API_KEY_HEADER 和 AuthConfiguration.API_KEY_VALUE 分别是 API Key Header 的名称和值,它们应该与 AuthConfiguration 类中定义的常量一致。

通过在测试请求中添加正确的 API Key Header,我们可以成功地模拟 API Key 认证,并确保 API 接口在受到保护的情况下能够正常工作。

总结

在 Spring Boot 应用中测试 API Key 认证的关键是在测试请求中添加正确的 API Key Header。通过使用 MockMvcRequestBuilders 的 header() 方法,我们可以轻松地添加 Header,并模拟真实场景,从而确保 API Key 认证的正确性和有效性。在编写测试用例时,请确保 API Key Header 的名称和值与配置类中的定义一致。

以上就是使用 Spring Boot 测试 API Key 认证的详细内容,更多请关注php中文网其它相关文章!

相关标签:
最佳 Windows 性能的顶级免费优化软件
最佳 Windows 性能的顶级免费优化软件

每个人都需要一台速度更快、更稳定的 PC。随着时间的推移,垃圾文件、旧注册表数据和不必要的后台进程会占用资源并降低性能。幸运的是,许多工具可以让 Windows 保持平稳运行。

下载
来源:php中文网
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn
最新问题
开源免费商场系统广告
热门教程
更多>
最新下载
更多>
网站特效
网站源码
网站素材
前端模板
关于我们 免责申明 意见反馈 讲师合作 广告合作 最新更新 English
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送
PHP中文网APP
随时随地碎片化学习

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