How to add a parameter to the interface in java

一、背景

一般在微服务架构中我们都会使用spring security oauth3来进行权限控制，我们将资源服务全部放在内网环境中，将API网关暴露在公网上，公网如果想要访问我们的资源必须经过API网关进行鉴权，鉴权通过后再访问我们的资源服务。我们根据如下图片来分析一下问题。

现在我们有三个服务：分别是用户服务、订单服务和产品服务。用户如果购买产品，则需要调用产品服务生成订单，那么我们在这个调用过程中有必要鉴权吗？答案是否定的，因为这些资源服务放在内网环境中，完全不用考虑安全问题。 

二、思路

如果要想实现这个功能，我们则需要来区分这两种请求，来自网关的请求进行鉴权，而服务间的请求则直接调用。

是否可以给接口增加一个参数来标记它是服务间调用的请求？

这样虽然可以实现两种请求的区分，但是实际中不会这么做。一般情况下服务间调用和网关请求的数据接口是同一个接口，如果写成两个接口来分别给两种请求调用，这样无疑增加了大量重复代码。也就是说我们一般不会通过改变请求参数的个数来实现这两种服务的区分。

虽然不能增加请求的参数个数来区分，但是我们可以给请求的header中添加一个参数用来区分。这样完全可以避免上面提到的问题。 

三、实现 

3.1 自定义注解

我们自定义一个Inner的注解，然后利用aop对这个注解进行处理

<code>1@Target(ElementType.METHOD)<br>2@Retention(RetentionPolicy.RUNTIME)<br>3@Documented<br>4public @interface Inner {<br>5    /**<br>6     * 是否AOP统一处理<br>7     */<br>8    boolean value() default true;<br>9}</code> 

<code> 1@Aspect<br> 2@Component<br> 3public class InnerAspect implements Ordered {<br> 4<br> 5    private final Logger log = LoggerFactory.getLogger(InnerAspect.class);<br> 6<br> 7    @Around("@annotation(inner)")<br> 8    public Object around(ProceedingJoinPoint point, Inner inner) throws Throwable {<br> 9        String header = ServletUtils.getRequest().getHeader(SecurityConstants.FROM);<br>10        if (inner.value() && !StringUtils.equals(SecurityConstants.FROM_IN, header)){<br>11            log.warn("访问接口 {} 没有权限", point.getSignature().getName());<br>12            throw new AccessDeniedException("Access is denied");<br>13        }<br>14        return point.proceed();<br>15    }<br>16<br>17    @Override<br>18    public int getOrder() {<br>19        return Ordered.HIGHEST_PRECEDENCE + 1;<br>20    }<br>21}</code> 

上面这段代码就是获取所有加了@Inner注解的方法或类，判断请求头中是否有我们规定的参数，如果没有，则不允许访问接口。 

3.2 暴露url

将所有注解了@Inner的方法和类暴露出来，允许不鉴权可以方法，这里需要注意的点是如果方法使用pathVariable 传参的，则需要将这个参数转换为*。如果不转换，当成接口的访问路径，则找不到此接口。

<code> 1@Configuration<br> 2public class PermitAllUrlProperties implements InitializingBean, ApplicationContextAware{<br> 3<br> 4    private static final Pattern PATTERN = Pattern.compile("\\{(.*?)\\}");<br> 5    private ApplicationContext applicationContext;<br> 6    private List<string> urls = new ArrayList();<br> 7    public static final String ASTERISK = "*";<br> 8<br> 9    @Override<br>10    public void afterPropertiesSet() {<br>11        RequestMappingHandlerMapping mapping = applicationContext.getBean(RequestMappingHandlerMapping.class);<br>12        Map<requestmappinginfo> map = mapping.getHandlerMethods();<br>13        map.keySet().forEach(info -> {<br>14            HandlerMethod handlerMethod = map.get(info);<br>15            // 获取方法上边的注解 替代path variable 为 *<br>16            Inner method = AnnotationUtils.findAnnotation(handlerMethod.getMethod(), Inner.class);<br>17            Optional.ofNullable(method).ifPresent(inner -> info.getPatternsCondition().getPatterns()<br>18                    .forEach(url -> urls.add(ReUtil.replaceAll(url, PATTERN, ASTERISK))));<br>19            // 获取类上边的注解, 替代path variable 为 *<br>20            Inner controller = AnnotationUtils.findAnnotation(handlerMethod.getBeanType(), Inner.class);<br>21            Optional.ofNullable(controller).ifPresent(inner -> info.getPatternsCondition().getPatterns()<br>22                    .forEach(url -> urls.add(ReUtil.replaceAll(url, PATTERN, ASTERISK))));<br>23        });<br>24    }<br>25<br>26    @Override<br>27    public void setApplicationContext(ApplicationContext context) {<br>28        this.applicationContext = context;<br>29    }<br>30<br>31    public List<string> getUrls() {<br>32        return urls;<br>33    }<br>34<br>35    public void setUrls(List<string> urls) {<br>36        this.urls = urls;<br>37    }<br>38}</string></string></requestmappinginfo></string></code> 

在资源服务器中，将请求暴露出来

<code> 1public void configure(HttpSecurity httpSecurity) throws Exception {<br> 2    //允许使用iframe 嵌套，避免swagger-ui 不被加载的问题<br> 3    httpSecurity.headers().frameOptions().disable();<br> 4    ExpressionUrlAuthorizationConfigurer<httpsecurity><br> 5        .ExpressionInterceptUrlRegistry registry = httpSecurity<br> 6        .authorizeRequests();<br> 7    // 将上面获取到的请求，暴露出来<br> 8    permitAllUrl.getUrls()<br> 9        .forEach(url -> registry.antMatchers(url).permitAll());<br>10    registry.anyRequest().authenticated()<br>11        .and().csrf().disable();<br>12}</httpsecurity></code>  
  

3.3 如何去请求

定义一个接口：

<code>1@PostMapping("test")<br>2@Inner<br>3public String test(@RequestParam String id){<br>4    return id;<br>5}</code> 

定义feign远程调用接口

<code>1@PostMapping("test")<br>2MediaFodderBean test(@RequestParam("id") String id,@RequestHeader(SecurityConstants.FROM) String from);</code>

服务间进行调用，传请求头

<code>1 String id = testService.test(id, SecurityConstants.FROM_IN);</code>  

四、思考 

4.1 安全性

上面虽然实现了服务间调用，但是我们将@Inner的请求暴露出去了，也就是说不用鉴权既可以访问到，那么我们是不是可以模拟一个请求头，然后在其他地方通过网关来调用呢？

答案是可以，那么，这时候我们就需要对网关中分发的请求进行处理，在网关中写一个全局拦截器，将请求头的form参数清洗。

<code> 1@Component<br> 2public class RequestGlobalFilter implements GlobalFilter, Ordered {<br> 3<br> 4    @Override<br> 5    public Mono<void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {<br> 6        // 清洗请求头中from 参数<br> 7        ServerHttpRequest request = exchange.getRequest().mutate()<br> 8            .headers(httpHeaders -> httpHeaders.remove(SecurityConstants.FROM))<br> 9            .build();<br>10        addOriginalRequestUrl(exchange, request.getURI());<br>11        String rawPath = request.getURI().getRawPath();<br>12        ServerHttpRequest newRequest = request.mutate()<br>13            .path(rawPath)<br>14            .build();<br>15        exchange.getAttributes().put(GATEWAY_REQUEST_URL_ATTR, newRequest.getURI());<br>16        return chain.filter(exchange.mutate()<br>17            .request(newRequest.mutate()<br>18                .build()).build());<br>19    }<br>20<br>21    @Override<br>22    public int getOrder() {<br>23        return -1000;<br>24    }<br>25}</void></code>  
  

4.2 扩展性

我们自定义@Inner注解的时候，放了一个boolean类型的value()，默认为true。如果我们想让这个请求可以通过网关访问的话，将value赋值为false即可。

<code>1@PostMapping("test")<br>2@Inner(value=false)<br>3public String test(@RequestParam String id){<br>4    return id;<br>5}</code>

The above is the detailed content of How to add a parameter to the interface in java. For more information, please follow other related articles on the PHP Chinese website!