Java从header取参数注解实现

1. 整体流程

下面是整件事情的流程：

步骤 描述
步骤1 定义一个注解，用于标识需要从header取值的参数
步骤2 创建一个拦截器，用于解析header中的参数并赋值给对应的注解
步骤3 在需要使用header参数的地方，使用定义的注解获取参数值

接下来我会详细介绍每一步的具体操作，包括需要做什么和使用的代码。

2. 定义注解

首先，我们需要定义一个注解，用于标识需要从header取值的参数。可以创建一个名为 HeaderParam 的注解：

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.PARAMETER)
public @interface HeaderParam {
    String value() default "";
}

这个注解用于标记方法参数，value 属性用于指定对应的header参数名。

3. 创建拦截器

接下来，我们需要创建一个拦截器，用于解析header中的参数并赋值给对应的注解。

import org.springframework.web.method.HandlerMethod;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.lang.reflect.Parameter;
import java.util.Objects;

public class HeaderParamInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        if (handler instanceof HandlerMethod) {
            HandlerMethod handlerMethod = (HandlerMethod) handler;
            Parameter[] parameters = handlerMethod.getMethod().getParameters();
            for (Parameter parameter : parameters) {
                HeaderParam headerParam = parameter.getAnnotation(HeaderParam.class);
                if (headerParam != null) {
                    String paramName = headerParam.value();
                    String paramValue = request.getHeader(paramName);
                    // 将header参数值赋值给对应的参数
                    Objects.requireNonNull(handlerMethod.getMethod()).invoke(handler, paramValue);
                }
            }
        }
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        // 拦截后处理
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        // 请求完成后处理
    }
}

在 preHandle 方法中，我们通过反射获取方法的参数，然后判断是否标有 HeaderParam 注解，如果有则获取对应的header参数值，并将其赋值给方法的参数。

4. 使用注解获取参数值

最后，我们可以在需要使用header参数的地方，使用刚刚定义的注解来获取参数值。

@PostMapping("/example")
public void exampleMethod(@HeaderParam("Authorization") String authorization) {
    // 使用从header获取的参数值
    // ...
}

在上面的例子中，我们使用 @HeaderParam 注解来标记参数 authorization，并指定了对应的header参数名为 "Authorization"。在方法中可以直接使用 authorization 参数来获取header中的参数值。

关系图

下面是整个流程的关系图：

erDiagram
    classdiagram --|> HeaderParam
    classdiagram --|> HeaderParamInterceptor
    classdiagram --|> exampleMethod

以上就是实现Java从header取参数注解的完整流程，希望对你有所帮助！