返回

访问Knife4j接口文档时，你可能需要sa-token全局过滤器

后端

sa-token与Knife4j集成：赋能接口访问控制与文档生成

一、简介

在现代化应用程序开发中，权限控制和接口文档生成扮演着至关重要的角色。sa-token 作为一个简单实用的权限控制框架，可以帮助开发者轻松实现接口访问控制；而Knife4j 是一个Swagger UI工具，可以帮助生成和查看接口文档。本文将详细介绍如何在项目中集成sa-token和Knife4j，实现对接口的有效访问控制和文档生成。

二、sa-token简介

sa-token是一个轻量级的Java权限控制框架，它提供了一系列权限控制策略，包括角色控制、权限控制和数据范围控制等。sa-token适用于前后端分离的系统，可以有效地管理用户权限。

三、Knife4j简介

Knife4j是一个基于Swagger的UI工具，它可以帮助开发者生成和查看接口文档。Knife4j支持多种语言，包括Java、Python、C++等，可以帮助开发者快速了解和使用RESTful API。

四、集成sa-token全局过滤器

在集成sa-token和Knife4j时，需要使用sa-token的全局过滤器来实现接口鉴权。

  1. 在项目中引入sa-token和Knife4j的依赖：
<dependency>
    <groupId>cn.dev33</groupId>
    <artifactId>sa-token-spring-boot-starter</artifactId>
    <version>3.3.0</version>
</dependency>
<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-spring-boot-starter</artifactId>
    <version>3.0.7</version>
</dependency>
  1. 创建sa-token的全局过滤器类：
import cn.dev33.satoken.stp.StpUtil;
import cn.dev33.satoken.web.filter.SaTokenAuthenticationFilter;
import javax.servlet.FilterChain;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;

public class MySaTokenAuthenticationFilter extends SaTokenAuthenticationFilter {

    @Override
    public void doFilter(HttpServletRequest request, HttpServletResponse response, FilterChain chain) throws IOException, ServletException {
        // 判断是否已登录
        if (!StpUtil.isLogin()) {
            // 未登录则直接返回
            return;
        }
        // 已登录则继续执行后续过滤器
        chain.doFilter(request, response);
    }
}
  1. 配置sa-token的全局过滤器：
@Configuration
public class SaTokenConfig {

    @Bean
    public MySaTokenAuthenticationFilter saTokenAuthenticationFilter() {
        return new MySaTokenAuthenticationFilter();
    }
}

五、示例代码

import cn.dev33.satoken.annotation.SaCheckPermission;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class TestController {

    @GetMapping("/api/test")
    @SaCheckPermission("user")
    public String test() {
        return "Hello World!";
    }
}

六、常见问题解答

  1. 为什么需要使用sa-token的全局过滤器？

    因为Knife4j需要对接口进行鉴权，而sa-token的全局过滤器可以实现对接口的鉴权。

  2. 如何使用sa-token的全局过滤器？

    在项目中引入sa-token和Knife4j的依赖，创建sa-token的全局过滤器类，配置sa-token的全局过滤器即可。

  3. 为什么在使用sa-token和Knife4j时可能会遇到访问接口文档失败的问题？

    因为Knife4j需要对接口进行鉴权，而如果没有使用sa-token的全局过滤器，则无法进行鉴权。

  4. 如何解决在使用sa-token和Knife4j时访问接口文档失败的问题？

    配置sa-token的全局过滤器即可解决该问题。

  5. sa-token和Knife4j是否可以同时使用？

    是的，sa-token和Knife4j可以同时使用。