SpringBoot（@ControllerAdvice） ResponseBodyAdvice接口全局统一返回控制，Api返回值是String 类型时异常

本文链接：https://blog.csdn.net/z69183787/article/details/130871122

简而言之：因为API接口返回的是String类型，默认会被StringHttpMessageConverter转换器捕获（支持所有MediaType 并且接口返回值是 String，并在RequestResponseBodyMethodProcessor#handleReturnValue，writeWithMessageConverters方法中的 canWrite 方法进行判断通过后，加入可被选择的返回值转换器中）


	/**
	 * A default constructor that uses {@code "ISO-8859-1"} as the default charset.
	 * @see #StringHttpMessageConverter(Charset)
	 */
	public StringHttpMessageConverter() {
		this(DEFAULT_CHARSET);
	}

	/**
	 * A constructor accepting a default charset to use if the requested content
	 * type does not specify one.
	 */
	public StringHttpMessageConverter(Charset defaultCharset) {
		super(defaultCharset, MediaType.TEXT_PLAIN, MediaType.ALL);
	}



	@Override
	public boolean supports(Class<?> clazz) {
		return String.class == clazz;
	}

解决方案：在controlleradvice中增加单独处理（转为String返回，供StringHttpMessageConverter使用）

    //增加返回string的特殊处理，否则会被stringhttpmessageconverter捕获 从而抛出convert异常
if (body instanceof String) {
    return JSON.toJSONString(new DfhResponse<>(ProblemCode.SUCCESS.getErrcode(),ProblemCode.SUCCESS.getErrmsg(),body));
}

package com.gaoshan.handler.response;

import com.alibaba.fastjson.JSON;
import com.gaoshan.axe.Result;
import org.nutz.lang.Lang;
import org.springframework.core.MethodParameter;
import org.springframework.http.MediaType;
import org.springframework.http.converter.HttpMessageConverter;
import org.springframework.http.server.ServerHttpRequest;
import org.springframework.http.server.ServerHttpResponse;
import org.springframework.web.bind.annotation.RestControllerAdvice;
import org.springframework.web.servlet.mvc.method.annotation.ResponseBodyAdvice;

import java.util.ArrayList;
import java.util.List;
import java.util.regex.Pattern;

@RestControllerAdvice(basePackages = "com.gaoshan")
public class GlobalResponseHandler implements ResponseBodyAdvice<Object> {

    List<String> ignorePaths = new ArrayList<>();

    static final List<String> DEFAULT_IGNORED_PATH = Lang.list("/swagger-resources.*", "/v2/api-docs", "/actuator.*", "/testStr2");

    public GlobalResponseHandler() {
        if (ignorePaths == null || ignorePaths.isEmpty()) {
            ignorePaths = DEFAULT_IGNORED_PATH;
        }
        ignorePaths.addAll(DEFAULT_IGNORED_PATH);
        this.ignorePaths = ignorePaths;
    }


    @Override
    public boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType) {
        return true;
    }

    @Override
    public Object beforeBodyWrite(Object body,
                                  MethodParameter returnType,
                                  MediaType selectedContentType,
                                  Class<? extends HttpMessageConverter<?>> selectedConverterType,
                                  ServerHttpRequest request,
                                  ServerHttpResponse response) {
        if (body instanceof Result || ignored(request.getURI().getRawPath())) {
            return body;
        }else if(body instanceof String){
            return JSON.toJSONString(Result.success(body));
        }
        return Result.success(body);

    }

    /**
     * @param path
     * @return
     */
    private boolean ignored(String path) {
        return ignorePaths.stream().anyMatch(item -> Pattern.matches(item, path));
    }
}

(1701条消息) spring ResponseBodyAdvice 消息转换器消息转换失败_stringhttpmessageconverter.getcontentlength_思想者0001的博客-CSDN博客https://blog.csdn.net/zhouwenjun0820/article/details/117036472 (1701条消息) Spring boot ResponseBodyAdvice接口全局统一返回控制，Api返回值是String 类型时异常_responsebodyadvice返回字符串_Crystalqy的博客-CSDN博客https://blog.csdn.net/Crystalqy/article/details/129285988