Spring boot 自定義 Resolver 支持 interface 類型參數

 

在編寫 RestController 層的代碼時，由於數據實體類定義了接口及實現類，本着面向接口編程的原則，我使用了接口作為 RestController 方法的入參。

代碼大致如下（省略具體業務部分）：

（1）模型接口：

public interface User {

    long getUserId();

    void setUserId(long userId);

    String getUserName();

    void setUserName(String userName);

    String getCategory();

    void setCategory(String category);
}

（2）模型實現類

public class UserImpl implements User{
    private long userId;
    private String userName;
    private String category;
    
    @Override
    public long getUserId() {
        return userId;
    }

    @Override
    public void setUserId(long userId) {
        this.userId = userId;
    }

    @Override
    public String getUserName() {
        return userName;
    }

    @Override
    public void setUserName(String userName) {
        this.userName = userName;
    }

    @Override
    public String getCategory() {
        return category;
    }

    @Override
    public void setCategory(String category) {
        this.category = category;
    }

}

（3）RestController POST接口代碼

    @PostMapping(value = "/updateUser", consumes = MediaType.APPLICATION_JSON_VALUE)
    public long updateUser(HttpSession session, @RequestBody User user) {
        System.out.println(session.getId());

        System.out.println(user.getUserName());
        System.out.println(user.getUserId());
        return user.getUserId();
    }

（4）前台用的axios發送的請求代碼

const AXIOS = axios.create({
  baseURL: 'http://localhost:9999',
  withCredentials: false,
  headers: {
    Accept: 'application/json',
    'Content-type': 'application/json'
  }
})

AXIOS.post('/updateUser', {
  userName: 'testName',
  userId: '123456789',
  category: 'XX'
})

 

但在運行測試時發現 Spring boot 本身的默認中並不支持將interface或抽象類作為方法的參數。報了如下錯誤：

2019-09-08 19:32:22.290 ERROR 12852 --- [nio-9999-exec-9] o.a.c.c.C.[.[.[/].[dispatcherServlet]    
: Servlet.service() for servlet [dispatcherServlet] in context with path [] threw exception 
[Request processing failed; nested exception is org.springframework.http.converter.HttpMessageConversionException: 
Type definition error: [simple type, class com.sample.demo.model.User]; nested exception is com.fasterxml.jackson.databind
.exc.InvalidDefinitionException: Cannot construct instance of `com.sample.demo.model.User` (no Creators, like default 
construct, exist): abstract types either need to be mapped to concrete types, have custom deserializer, 
or contain additional type information at [Source: (PushbackInputStream); line: 1, column: 1]] with root cause
...

大致意思時不存在創建實例的構造函數，抽象類型需要配置映射到具體的實現類。

 

解決方案一：

於是我上網搜了下解決方法，最終在 StackOverflow 上找到一種解決方案：

@JsonTypeInfo(use = Id.NAME, include = As.PROPERTY, property = "type") @JsonSubTypes({@JsonSubTypes.Type(value = A.class, name = "A"), @JsonSubTypes.Type(value = B.class, name = "B")}) public interface MyInterface { }

通過添加注解的方式，將接口映射到實現類。

 

這種方法可以解決方法入參為接口的問題，但同時又會引入一個問題：接口和實現類相互引用，導致循環依賴。而且如果我有很多數據類的接口及實現類的話，每個接口都要寫一遍注解。

於是繼續探索。。。

 

解決方案二：

繼承 HandlerMethodArgumentResolver  接口實現里面的 supportsParameter  和  resolveArgument 方法。

（1）在supportsParameter 方法中返回支持的類型。其中MODEL_PATH為實體類的包路徑，下列代碼中默認支持了包內的所有類型。

    @Override
    public boolean supportsParameter(MethodParameter parameter) {
        return parameter.getParameterType().getName().startsWith(MODEL_PATH);
    }

（2）在 resolveArgument 方法中，通過反射生成一個實現類的對象並返回。

 @Override
    public Object resolveArgument(MethodParameter parameter, ModelAndViewContainer modelAndViewContainer,
                                  NativeWebRequest nativeWebRequest, WebDataBinderFactory webDataBinderFactory) throws Exception {
        Class<?> parameterType = parameter.getParameterType();
        String implName = parameterType.getName() + SUFFIX;
        Class<?> implClass = Class.forName(implName);

        if (!parameterType.isAssignableFrom(implClass)) {
            throw new IllegalStateException("type error:" + parameterType.getName());
        }

        Object impl = implClass.newInstance();
        WebDataBinder webDataBinder = webDataBinderFactory.createBinder(nativeWebRequest, impl, parameter.getParameterName());
        ServletRequest servletRequest = nativeWebRequest.getNativeRequest(ServletRequest.class);
        Assert.notNull(servletRequest, "servletRequest is null.");

        ServletRequestDataBinder servletRequestDataBinder = (ServletRequestDataBinder) webDataBinder;
        servletRequestDataBinder.bind(servletRequest);
        return impl;
    }

（3）最后添加到Spring boot 的配置中

    @Bean
    public WebMvcConfigurer webMvcConfigurer() {
        return new WebMvcConfigurerAdapter() {
            @Override
            public void addArgumentResolvers(List<HandlerMethodArgumentResolver> argumentResolvers) {
                argumentResolvers.add(new MethodInterfaceArgumentResolver());
                super.addArgumentResolvers(argumentResolvers);
            }
        };
    }

 

方案二可以解決找不到構造函數的問題，運行不會報錯，也不會導致循環依賴，但卻沒法將前台的數據注入到入參對象中。也就是給方法傳入的只是一個剛new出來的UserImpl 對象。

 

經過測試發現，雖然對post請求無法注入前台數據，但對於get請求，還是可以的：

前台get方法代碼：

AXIOS.get('/getUser?userName=Haoye&userId=123456789&category=XX')

后台get方法代碼：

    @GetMapping("/getUser")
    public User getUser(User user) {
        System.out.println(user.getUserName());
        return user;
    }

 

解決方案三：

由於在網上沒有找到好的解決方案，我最后通過看Spring boot 源碼 + 調試跟蹤 + 寫demo嘗試的方式，終於找到了好的解決方案。

這里先分享下大致的思路：

（1）Spring boot的相關代碼應該在 HandlerMethodArgumentResolver 接口對應的包里或者附近。但這樣找還是比較慢，因為代碼還是很多。

 

（2）通過打斷點，看看哪里調用了 public boolean supportsParameter(MethodParameter parameter) 方法。

於是找到了HandlerMethodArgumentResolverComposite 類調用的地方：

  從上圖可以看到，當前處理的是第一個參數HttpSession。

 

（3）先將controller方法的入參先改為UserImpl，也就是實現類，在步驟（2）的截圖對應的代碼中打斷點。

繼續調試，找到Spring boot 解析被@RequestBody 注解標注的參數UserImpl user 的時候，用的是什么Resolver。

如下圖所示，調用Evaluate窗口獲取類型信息，點擊 Navigate 跳轉到對應的類 RequestResponseBodyMethodProcessor。

 

 （4） RequestResponseBodyMethodProcessor 類中的 resolveArgument 方法源碼如下：

    /**
     * Throws MethodArgumentNotValidException if validation fails.
     * @throws HttpMessageNotReadableException if {@link RequestBody#required()}
     * is {@code true} and there is no body content or if there is no suitable
     * converter to read the content with.
     */
    @Override
    public Object resolveArgument(MethodParameter parameter, @Nullable ModelAndViewContainer mavContainer,
            NativeWebRequest webRequest, @Nullable WebDataBinderFactory binderFactory) throws Exception {

        parameter = parameter.nestedIfOptional();
        Object arg = readWithMessageConverters(webRequest, parameter, parameter.getNestedGenericParameterType());
        String name = Conventions.getVariableNameForParameter(parameter);

        if (binderFactory != null) {
            WebDataBinder binder = binderFactory.createBinder(webRequest, arg, name);
            if (arg != null) {
                validateIfApplicable(binder, parameter);
                if (binder.getBindingResult().hasErrors() && isBindExceptionRequired(binder, parameter)) {
                    throw new MethodArgumentNotValidException(parameter, binder.getBindingResult());
                }
            }
            if (mavContainer != null) {
                mavContainer.addAttribute(BindingResult.MODEL_KEY_PREFIX + name, binder.getBindingResult());
            }
        }

        return adaptArgumentIfNecessary(arg, parameter);
    }

回到最初的問題，導致無法傳入interface類型參數的原因是接口無法實例化。那既然如此，我們要修改的地方肯定是Spring boot 嘗試實例化接口的地方，也就是實例化失敗進而拋出異常的地方。

一路順騰摸瓜，最終發現 readWithMessageConverters 方法中, 通過給 readWithMessageConverters 方法傳入類型信息，最終生成參數實例。

 

（5） 從（4）中可以看到，相關方法的訪問級別為 protected，也就是我們可以通過繼承 RequestResponseBodyMethodProcessor 並覆寫 readWithMessageConverters 即可。

通過反射，注入 User 接口的實現類型 UserImpl 的class：

 

package com.sample.demo.config;

import org.springframework.core.MethodParameter;
import org.springframework.http.converter.HttpMessageConverter;
import org.springframework.http.converter.HttpMessageNotReadableException;
import org.springframework.web.HttpMediaTypeNotSupportedException;
import org.springframework.web.context.request.NativeWebRequest;
import org.springframework.web.servlet.mvc.method.annotation.RequestResponseBodyMethodProcessor;

import java.io.IOException;
import java.lang.reflect.Type;
import java.util.List;

/**
 * @breaf
 * @author https://cnblogs.com/laishenghao
 * @date 2019/9/7
 * @since 1.0
 **/
public class ModelRequestBodyMethodArgumentResolver extends RequestResponseBodyMethodProcessor {
    private static final String MODEL_PATH = "com.sample.demo.model";
    private static final String SUFFIX = "Impl";

    public ModelRequestBodyMethodArgumentResolver(List<HttpMessageConverter<?>> converters) {
        super(converters);
    }

    @Override
    public boolean supportsParameter(MethodParameter methodParameter) {
        return super.supportsParameter(methodParameter)
            && methodParameter.getParameterType().getName().startsWith(MODEL_PATH);
    }

    @Override
    protected <T> Object readWithMessageConverters(NativeWebRequest webRequest, MethodParameter parameter, Type paramType)
            throws IOException, HttpMediaTypeNotSupportedException, HttpMessageNotReadableException {
        try {
            Class<?> clazz = Class.forName(paramType.getTypeName() + SUFFIX);
            return super.readWithMessageConverters(webRequest, parameter, clazz);
        } catch (ClassNotFoundException e) {
            return null;
        }
    }

}

 

 完成上面的代碼后，跑了一下，發現並沒有什么用，報的錯誤還是跟最開始的一樣。

由此推測，應該是Spring boot 默認配置的 Resolver的優先級比較高，導致我們自定義的並沒有生效。

於是繼續查找原因，發現自定義的Resolver的優先級幾乎墊底了，在遠未調用到之前就被它的父類搶了去。

 

（6）提高自定義 Resolver的優先級。

一個可行的方法是：在Spring boot 框架初始化完成后，獲取到所有的Resolver，然后將自定義的加在ArrayList的前面。

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.method.support.HandlerMethodArgumentResolver;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;
import org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter;

import javax.annotation.PostConstruct;
import java.util.ArrayList;
import java.util.List;

/**
 * @breaf
 * @blog https://www.cnblogs.com/laishenghao
 * @date 2019/9/7
 * @since 1.0
 **/
@Configuration
public class CustomConfigurations {
    @Autowired
    private RequestMappingHandlerAdapter adapter;

    @PostConstruct
    public void prioritizeCustomArgumentMethodHandlers () {
        List<HandlerMethodArgumentResolver> allResolvers = adapter.getArgumentResolvers();
        if (allResolvers == null) {
            allResolvers = new ArrayList<>();
        }
        List<HandlerMethodArgumentResolver> customResolvers = adapter.getCustomArgumentResolvers ();
        if (customResolvers == null) {
            customResolvers = new ArrayList<>();
        }
        ModelRequestBodyMethodArgumentResolver argumentResolver = new ModelRequestBodyMethodArgumentResolver(adapter.getMessageConverters());
        customResolvers.add(0,argumentResolver);

        List<HandlerMethodArgumentResolver> argumentResolvers = new ArrayList<> (allResolvers);
        argumentResolvers.removeAll (customResolvers);
        argumentResolvers.addAll (0, customResolvers);
        adapter.setArgumentResolvers (argumentResolvers);
    }
}

 

值得注意的是，getResolvers()方法返回的是不可更改的List，不能直接插入。

 

至此，自定義參數處理器就可以解析RestController標注的類中的方法的 interface類型參數了。

 

如果要支持其他類型（比如抽象類、枚舉類），或者使用自定義注解標注入參，也可以通過類似的方法來實現。

 

本文地址：https://www.cnblogs.com/laishenghao/p/11488724.html