feat: 添加 feign 拦截器，传递 token、用户信息

Author: cadecode

example/example_svc/src/main/java/com/github/cadecode/uniboot/example/svc/controller/RpcExampleController.java

@@ -0,0 +1,36 @@
+package com.github.cadecode.uniboot.example.svc.controller;
+
+import com.github.cadecode.uniboot.framework.api.annotation.ApiFormat;
+import com.github.cadecode.uniboot.framework.api.feign.ExampleClient;
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiOperation;
+import lombok.RequiredArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RequestParam;
+import org.springframework.web.bind.annotation.RestController;
+
+/**
+ * RPC 测试
+ *
+ * @author Cade Li
+ * @since 2023/7/29
+ */
+@ApiFormat
+@Slf4j
+@RequiredArgsConstructor
+@Api(tags = "RPC 测试")
+@RestController
+@RequestMapping("rpc_example")
+public class RpcExampleController {
+
+    private final ExampleClient exampleClient;
+
+    @ApiOperation("传递字符串")
+    @PostMapping("test_str")
+    public String testStr(@RequestParam String str) {
+        return exampleClient.testStr(str);
+    }
+
+}

framework/framework_api/src/main/java/com/github/cadecode/uniboot/framework/api/config/FeignConfig.java

@@ -0,0 +1,53 @@
+package com.github.cadecode.uniboot.framework.api.config;
+
+import cn.hutool.core.util.CharsetUtil;
+import cn.hutool.core.util.EscapeUtil;
+import cn.hutool.core.util.ObjectUtil;
+import cn.hutool.core.util.StrUtil;
+import cn.hutool.extra.servlet.ServletUtil;
+import com.github.cadecode.uniboot.common.core.util.JacksonUtil;
+import com.github.cadecode.uniboot.framework.api.bean.dto.SysUserDto.SysUserDetailsDto;
+import com.github.cadecode.uniboot.framework.api.consts.SecurityConst;
+import com.github.cadecode.uniboot.framework.api.util.SecurityUtil;
+import feign.RequestInterceptor;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.web.context.request.RequestContextHolder;
+import org.springframework.web.context.request.ServletRequestAttributes;
+
+import javax.servlet.http.HttpServletRequest;
+
+/**
+ * OpenFeign 配置类
+ *
+ * @author Cade Li
+ * @since 2023/7/29
+ */
+@Configuration
+public class FeignConfig {
+
+    @Bean
+    public RequestInterceptor requestInterceptor() {
+        return requestTemplate -> {
+            // 获取请求对象
+            HttpServletRequest sRequest = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest();
+            if (ObjectUtil.isNull(sRequest)) {
+                return;
+            }
+            // 传递用户 token
+            String token = SecurityUtil.getTokenFromRequest(sRequest);
+            if (StrUtil.isNotEmpty(token)) {
+                requestTemplate.header(SecurityUtil.getHeader(), token);
+            }
+            // 传递用户详细信息
+            String userDetailsJson = ServletUtil.getHeader(sRequest, SecurityConst.USER_DETAILS, CharsetUtil.CHARSET_UTF_8);
+            if (StrUtil.isEmpty(userDetailsJson)) {
+                SysUserDetailsDto userDetailsDto = SecurityUtil.getUserDetails(null);
+                userDetailsJson = JacksonUtil.toJson(userDetailsDto);
+            }
+            requestTemplate.header(SecurityConst.USER_DETAILS, EscapeUtil.escape(userDetailsJson));
+            // 配置客户端 IP
+            requestTemplate.header("X-Forwarded-For", ServletUtil.getClientIP(sRequest));
+        };
+    }
+}

framework/framework_api/src/main/java/com/github/cadecode/uniboot/framework/api/consts/SecurityConst.java

@@ -0,0 +1,12 @@
+package com.github.cadecode.uniboot.framework.api.consts;
+
+/**
+ * Security 常量
+ *
+ * @author Cade Li
+ * @since 2023/7/29
+ */
+public interface SecurityConst {
+
+    String USER_DETAILS = "feign-user-details";
+}

framework/framework_api/src/main/java/com/github/cadecode/uniboot/framework/api/feign/ExampleClient.java

@@ -0,0 +1,20 @@
+package com.github.cadecode.uniboot.framework.api.feign;
+
+import com.github.cadecode.uniboot.framework.api.consts.SvcName;
+import org.springframework.cloud.openfeign.FeignClient;
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.RequestParam;
+
+/**
+ * 测试 feign client
+ *
+ * @author Cade Li
+ * @since 2023/7/28
+ */
+@FeignClient(contextId = "ExampleClient", name = SvcName.FRAMEWORK)
+public interface ExampleClient {
+
+    @PostMapping("example/test_str")
+    String testStr(@RequestParam("str") String str);
+
+}

framework/framework_api/src/main/java/com/github/cadecode/uniboot/framework/api/security/filter/JwtTokenAuthFilterService.java

@@ -28,7 +28,7 @@
 public class JwtTokenAuthFilterService extends TokenAuthFilterService {
 
     @Override
-    public void filter(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain) throws ServletException, IOException {
+    public void handler(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain) throws ServletException, IOException {
         String requestURI = request.getRequestURI();
         String jwtToken = SecurityUtil.getTokenFromRequest(request);
         // token 不存在

framework/framework_api/src/main/java/com/github/cadecode/uniboot/framework/api/security/filter/RedisTokenAuthFilterService.java

@@ -32,7 +32,7 @@
 public class RedisTokenAuthFilterService extends TokenAuthFilterService {
 
     @Override
-    public void filter(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain) throws ServletException, IOException {
+    public void handler(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain) throws ServletException, IOException {
         String requestURI = request.getRequestURI();
         String uuidToken = SecurityUtil.getTokenFromRequest(request);
         // token 不存在

framework/framework_api/src/main/java/com/github/cadecode/uniboot/framework/api/security/filter/TokenAuthFilterService.java

@@ -1,12 +1,16 @@
 package com.github.cadecode.uniboot.framework.api.security.filter;
 
 import cn.hutool.core.util.CharsetUtil;
+import cn.hutool.core.util.EscapeUtil;
+import cn.hutool.core.util.ObjectUtil;
 import cn.hutool.extra.servlet.ServletUtil;
 import cn.hutool.http.ContentType;
 import com.github.cadecode.uniboot.common.core.enums.ApiErrorCode;
 import com.github.cadecode.uniboot.common.core.extension.strategy.StrategyService;
 import com.github.cadecode.uniboot.common.core.util.JacksonUtil;
 import com.github.cadecode.uniboot.common.core.web.response.ApiResult;
+import com.github.cadecode.uniboot.framework.api.bean.dto.SysUserDto.SysUserDetailsDto;
+import com.github.cadecode.uniboot.framework.api.consts.SecurityConst;
 import org.springframework.security.authentication.UsernamePasswordAuthenticationToken;
 import org.springframework.security.core.context.SecurityContextHolder;
 import org.springframework.security.core.userdetails.UserDetails;
@@ -54,5 +58,19 @@ protected void writeResponse(HttpServletResponse response, ApiErrorCode errorCod
         ServletUtil.write(response, JacksonUtil.toJson(result), ContentType.JSON.toString(CharsetUtil.CHARSET_UTF_8));
     }
 
-    public abstract void filter(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain) throws ServletException, IOException;
+    public void filter(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain) throws ServletException, IOException {
+        String escapedJson = ServletUtil.getHeader(request, SecurityConst.USER_DETAILS, CharsetUtil.CHARSET_UTF_8);
+        if (ObjectUtil.isNotEmpty(escapedJson)) {
+            SysUserDetailsDto userDetailsDto = JacksonUtil.toBean(EscapeUtil.unescape(escapedJson), SysUserDetailsDto.class);
+            if (ObjectUtil.isNotNull(userDetailsDto)) {
+                setAuthentication(request, userDetailsDto);
+                filterChain.doFilter(request, response);
+                return;
+            }
+        }
+        handler(request, response, filterChain);
+    }
+
+    public abstract void handler(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain) throws ServletException, IOException;
+
 }

framework/framework_svc/src/main/java/com/github/cadecode/uniboot/framework/svc/controller/ExampleController.java

@@ -0,0 +1,35 @@
+package com.github.cadecode.uniboot.framework.svc.controller;
+
+import com.github.cadecode.uniboot.framework.api.annotation.ApiFormat;
+import io.swagger.annotations.Api;
+import io.swagger.annotations.ApiOperation;
+import lombok.RequiredArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RequestParam;
+import org.springframework.web.bind.annotation.RestController;
+
+/**
+ * 测试接口
+ *
+ * @author Cade Li
+ * @since 2023/7/29
+ */
+@ApiFormat
+@Slf4j
+@RequiredArgsConstructor
+@Api(tags = "测试接口")
+@RestController
+@RequestMapping("example")
+public class ExampleController {
+
+    // For feign client
+    @ApiFormat(false)
+    @ApiOperation("传递字符串")
+    @PostMapping("test_str")
+    public String testStr(@RequestParam String str) {
+        return str;
+    }
+
+}