Technologieaustausch

한어Русский языкEnglishFrançaisIndonesianSanskrit日本語DeutschPortuguêsΕλληνικάespañolItalianoSuomalainenLatina

In diesem Artikel wird hauptsächlich die Methode zum Festlegen von JWT-Informationen im Filter beschrieben, um Identitätsinformationen über die Filterklasse von Springboot zu speichern.
Prozess: Anfrage->Filter->Anfragetextinformationen analysieren->In Threadlocal einfügen

Filter definieren: Ein Filter (Filter), der die Servlet-Spezifikation verwendet und über die Annotation @WebFilter registriert wird, um alle HTTP-Anforderungen abzufangen, die mit dem /api-Pfad übereinstimmen.

Die Annotation @WebFilter("/api") gibt an, dass der Filter auf alle Anforderungen angewendet wird, die auf den /api-Pfad zugreifen.
@Component-Anmerkung:

@Component ist eine Annotation des Spring-Frameworks, die angibt, dass JwtFilter eine Spring-Komponente ist, die vom Spring-Container verwaltet werden kann und die Abhängigkeitsinjektion unterstützt.
doFilter-Methode:
Die doFilter-Methode definiert, wie der Filter Anfragen und Antworten abfängt und verarbeitet, die in das Servlet oder den Servlet-Container gelangen.
Methodensignatur:

public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
    throws IOException, ServletException;
1
2

Diese Methode akzeptiert drei Parameter: ServletRequest-Anfrage, ServletResponse-Antwort und FilterChain-Kette.
Es kann eine IOException oder eine ServletException auslösen.
Anfrage und Antwort:

Die ersten beiden Parameter der doFilter-Methode stellen die aktuellen Anforderungs- und Antwortobjekte dar. In dieser Methode können Sie Anforderungsdaten lesen und Anforderungen und Antworten ändern.
Normalerweise müssen Sie am Ende der doFilter-Methode chain.doFilter(request, Response) aufrufen, um mit der Ausführung des nächsten Filters oder der nächsten Zielressource in der Filterkette fortzufahren.

Wenn Sie den Anforderungsinhalt erneut ändern möchten, können Sie HttpServletRequestWrapper verwenden. HttpServletRequestWrapper ist eine Wrapper-Klasse, die die HttpServletRequest-Schnittstelle erweitert und es Ihnen ermöglicht, die Anforderungsverarbeitung zu ändern oder zu erweitern. Zu den Zwecken für die Verwendung von HttpServletRequestUriWrapper (bei der es sich möglicherweise um eine benutzerdefinierte Wrapper-Klasse handelt, die von HttpServletRequestWrapper erbt) gehören normalerweise:

Anforderungs-URI ändern:

Möglicherweise möchten Sie den Anforderungs-URI ändern, nicht jedoch das ursprüngliche HttpServletRequest-Objekt. Durch die Verwendung von HttpServletRequestUriWrapper können Sie die ursprüngliche Anfrage umschließen und einen geänderten URI bereitstellen.
Behalten Sie die ursprüngliche Anfrage unverändert bei:

Durch die Verwendung eines Wrappers bleibt das ursprüngliche Anforderungsobjekt unverändert, während Sie gleichzeitig bestimmte Aspekte der Anforderung an einem bestimmten Punkt in der Filterkette ändern können.
Filterung und Vorverarbeitung:

Bevor Sie filterChain.doFilter aufrufen, können Sie der doFilter-Methode beliebige Vorverarbeitungslogik hinzufügen, z. B. das Ändern von Anforderungsparametern, das Ändern von Anforderungspfaden, das Hinzufügen oder Ändern von Anforderungsheadern usw.

import jakarta.servlet.Filter;
import jakarta.servlet.FilterChain;
import jakarta.servlet.FilterConfig;
import jakarta.servlet.ServletException;
import jakarta.servlet.ServletRequest;
import jakarta.servlet.ServletResponse;
import jakarta.servlet.annotation.WebFilter;
import jakarta.servlet.http.HttpServletRequest;
import lombok.extern.slf4j.Slf4j;
import org.slf4j.MDC;

@WebFilter("/api")
@Component
@Slf4j
public class JwtFilter implements Filter {

    @Override
    public void init(FilterConfig filterConfig) {
        // noting to do
    }

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain)
            throws IOException, ServletException {

        var httpRequest = (HttpServletRequest) servletRequest;
        var requestBodyPayload = StreamUtils.copyToString(servletRequest.getInputStream(), StandardCharsets.UTF_8);

        // 解析Body参数，并存入threadLocal管理
        var jwtInfo = JwtUtil.getJwtInfoFromReq(requestBodyPayload);
        JwtUtil.setJwtInfo(jwtInfo);

        // 读取过body，需要重新设置body
        var wrapper = new HttpServletRequestUriWrapper(httpRequest, httpRequest.getRequestURI(), requestBodyPayload);

        // 将请求传递到下一个过滤器（或者最终到达控制器方法）
        filterChain.doFilter(wrapper, servletResponse);
    }

    @Override
    public void destroy() {
        JwtUtil.removeJwtInfo();
        MDC.clear();
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46

JWT-Informationen:

@Slf4j
@Component
public class JwtUtil {

    /** 线程jwt信息维护 */
    private static final ThreadLocal<JwtInfo> REQUEST_BASE_INFO_THREAD_LOCAL = new ThreadLocal<>();

    /** 解析jwt信息 */
    public static JwtInfo getJwtInfoFromReq(String requestBodyPayload) {
        var jwtInfo = new JwtInfo();
        try {
            var requestBody = JsonUtil.getJsonNode(requestBodyPayload);
            log.info("[JwtUtil] RequestBody -> {}", requestBody);

            // 解析requestBody，转为jwtInfo对象
          
            jwtInfo.setRequestId(requestBody.get("RequestId") != null ? requestBody.get("RequestId").asText() : "");
            jwtInfo.setRegion(requestBody.get("Region") != null ? requestBody.get("Region").asText() : "");
            log.info("[JwtUtil] JwtInfo -> {}", jwtInfo);
        } catch (Exception e) {
            log.error("[JwtUtil] Parse RequestBodyInfo Error, Error Message -> {}", e.getMessage(), e);
        }
        return jwtInfo;
    }

    /** 获取jwt信息 */
    public static JwtInfo getJwtInfo() {
        var jwtInfo = REQUEST_BASE_INFO_THREAD_LOCAL.get();
        if (Objects.isNull(jwtInfo)) {
            final var requestAttributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
            if (Objects.nonNull(requestAttributes)) {
                var requestBodyPayload = "";
                try {
                    requestBodyPayload = StreamUtils.copyToString(requestAttributes.getRequest().getInputStream(),
                            StandardCharsets.UTF_8);
                } catch (Exception e) {
                    log.error("[JwtUtil] Parse RequestBodyInfo Error, Error Message -> {}", e.getMessage());
                }
                jwtInfo = getJwtInfoFromReq(requestBodyPayload);
                setJwtInfo(jwtInfo);
            }
        }
        return jwtInfo;
    }

    /** 将jwt信息存入threadLocal中 */
    public static void setJwtInfo(JwtInfo jwtInfo) {
        REQUEST_BASE_INFO_THREAD_LOCAL.set(jwtInfo);
        // 将traceId写入日志变量
        MDC.put("traceId", jwtInfo.getRequestId());
    }

    public static void setJwtInfo(String appId, String ownerUin) {
        var jwtInfo = new JwtUtil.JwtInfo();
        jwtInfo.setRequestId(UUID.randomUUID().toString());

        setJwtInfo(jwtInfo);
    }

    /** 从threadLocal中删除jwt信息 */
    public static void removeJwtInfo() {
        REQUEST_BASE_INFO_THREAD_LOCAL.remove();
    }

    @Data
    public static class JwtInfo {

      
        @JsonPropertyDescription("请求requestId")
        private String requestId;


        @JsonPropertyDescription("请求的Region")
        private String region;
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77

Holen Sie sich den Inhalt in jwt und senden Sie andere http-Anfragen:

   public static JsonNode sendHttpRequest(String method, String action, String url, Map<String, Object> body)
            throws IOException, InterruptedException {

        // 设置通用参数
        var jwtInfo = JwtUtil.getJwtInfo();
        if (jwtInfo != null) {
            body.put("RequestId", jwtInfo.getRequestId());
            body.put("AppId", Integer.valueOf(jwtInfo.getAppId()));
            body.put("Uin", jwtInfo.getUin());
            body.put("Region", jwtInfo.getRegion());
        }

        // 设置action
        body.put("Action", action);

        // 发送http请求，拿到请求结果
        HttpConnectUtil.ResponseInfo responseInfo = switch (method) {
            case "GET" -> HttpConnectUtil.sendGetByJson(url, JsonUtil.toJson(body));
            case "POST" -> HttpConnectUtil.sendPost(url, JsonUtil.toJson(body), new HashMap<>(2));
            default -> new HttpConnectUtil.ResponseInfo();
        };

        // 检查Api3格式返回结果，并解析
        var jsonResponse = JsonUtil.getJsonNode(responseInfo.getContent()).get("Response");
        var jsonError = jsonResponse.get("Error");
        if (jsonError != null) {
            var errorCode = jsonError.get("Code").asText();
            var errorMessage = jsonError.get("Message").asText();
            throw new ApiException(ErrorCode.INTERNAL_ERROR,
                    String.format("错误码:[%s],错误信息:[%s]", errorCode, errorMessage));
        }
        return jsonResponse;
    }
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33