springboot中自定义参数与返回值处理器及数据转化器

参数解析器:

自定义一个类实现 HandlerMethodArgumentResolver,并注入容器中。
示例代码:

@Component
public class TokenArgumentResolver implements HandlerMethodArgumentResolver {
    @Override
    // 是否支持某个参数
    public boolean supportsParameter(MethodParameter parameter) {
        Token token = parameter.getParameterAnnotation(Token.class);
        return token != null;
    }

    @Override
    // 解析参数
    public Object resolveArgument(MethodParameter parameter, ModelAndViewContainer mavContainer,
                                  NativeWebRequest webRequest, WebDataBinderFactory binderFactory) throws Exception {
        return webRequest.getHeader("token");
    }
}

返回值处理器:

示例代码

@Component
public class YmlReturnValueHandler implements HandlerMethodReturnValueHandler {
    @Override
    public boolean supportsReturnType(MethodParameter returnType) {
        Yml yml = returnType.getMethodAnnotation(Yml.class);
        return yml != null;
    }

    @Override                   //  返回值
    public void handleReturnValue(Object returnValue, MethodParameter returnType,
                                  ModelAndViewContainer mavContainer, NativeWebRequest webRequest) throws Exception {
        // 1. 转换返回结果为 yaml 字符串
        String str = new Yaml().dump(returnValue);

        // 2. 将 yaml 字符串写入响应
        HttpServletResponse response = webRequest.getNativeResponse(HttpServletResponse.class);
        response.setContentType("text/plain;charset=utf-8");
        response.getWriter().print(str);

        // 3. 设置请求已经处理完毕
        mavContainer.setRequestHandled(true);
    }
}

数据转化器

1.可以解析控制器的 @InitBinder 标注方法作为扩展点,添加自定义转换器

@Controller 中 @InitBinder 标注的方法,由 RequestMappingHandlerAdapter 会在控制器方法首次执行时解析并记录(只对当前控制器生效)
@ControllerAdvice 中 @InitBinder 标注的方法,由 RequestMappingHandlerAdapter 在初始化时解析并记录(对所有的控制器生效)
在RequestMappingHandlerAdapter源码中有这两个属性
在这里插入图片描述

@InitBinder
public void aaa(WebDataBinder dataBinder) {
	 // 扩展 dataBinder 的转换器
	 dataBinder.addCustomFormatter(new MyDateFormatter("用 @InitBinder 方式扩展的"));
}

自定义配置器的代码

public class MyDateFormatter implements Formatter<Date> {
    private static final Logger log = LoggerFactory.getLogger(MyDateFormatter.class);
    private final String desc;

    public MyDateFormatter(String desc) {
        this.desc = desc;
    }

    @Override
    public String print(Date date, Locale locale) {
        SimpleDateFormat sdf = new SimpleDateFormat("yyyy|MM|dd");
        return sdf.format(date);
    }

    @Override
    public Date parse(String text, Locale locale) throws ParseException {
        log.debug(">>>>>> 进入了: {}", desc);
        SimpleDateFormat sdf = new SimpleDateFormat("yyyy|MM|dd");
        return sdf.parse(text);
    }
}

  • 0
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
### 回答1: 可以使用 @param 和 @return 标签来自定义参数返回值。在方法的注释,使用 @param 标签来描述参数的名称和类型,例如:@param name 参数名称,参数类型。使用 @return 标签来描述返回值的类型和含义,例如:@return 返回值类型,返回值含义。在代码,使用相应的参数名称和返回值类型来定义方法的参数返回值。 ### 回答2: JavaDoc是一种用于为Java源代码添加注释的标准化格式。在编写Java代码时,我们可以使用JavaDoc来为方法、类、接口等添加注释,以提供更详细的信息和说明。 对于需要自定义参数返回值的实现方式,我们可以在JavaDoc使用特定的标签来描述参数返回值的信息。 对于自定义参数,我们可以使用`@param`标签来对参数进行说明。在方法注释,使用`@param 参数参数描述`的格式来描述方法的参数。例如,对于一个求和方法,可以使用以下的JavaDoc注释来描述参数: ``` /** * 求和方法 * * @param a 加数 * @param b 加数 * @return 和 */ public int sum(int a, int b) { return a + b; } ``` 对于自定义返回值,我们可以使用`@return`标签来对返回值进行说明。在方法注释,使用`@return 返回值描述`的格式来描述方法的返回值。例如,对于上述的求和方法,可以使用以下的JavaDoc注释来描述返回值: ``` /** * 求和方法 * * @param a 加数 * @param b 加数 * @return 和 */ public int sum(int a, int b) { return a + b; } ``` 在编写自定义参数返回值JavaDoc时,我们应该尽量详细地描述参数返回值的含义、类型和约束,以便其他开发人员能够更好地理解和使用我们编写的代码。同时,我们还可以使用其他常用的JavaDoc标签,如`@throws`标签来描述方法可能抛出的异常等。 总之,通过在JavaDoc使用`@param`和`@return`标签,我们可以很方便地自定义参数返回值的注释,提供更详细的信息和说明,以帮助其他开发人员更好地理解和使用我们的代码。 ### 回答3: JavaDoc是用于文档注释的工具。在编写Java代码时,我们可以使用JavaDoc注释来描述类、方法和变量的作用、参数返回值等信息,以方便其他开发人员理解和使用我们编写的代码。 当需要自定义参数返回值时,我们可以在JavaDoc注释使用@param和@return标签来描述。下面是自定义参数返回值的实现方式: 1. 自定义参数: 在JavaDoc注释,使用@param标签来描述每个参数的作用和使用方法。例如,如果有一个名为"num"的整数参数,我们可以这样描述: /** * 计算平方值。 * * @param num 要计算平方值的整数。 * @return 平方值。 */ public int calculateSquare(int num) { return num * num; } 在@param标签后面的描述,我们可以指定参数的名称、类型和其他相关说明,使其他开发人员在使用该方法时能够正确理解和使用参数。 2. 自定义返回值: 在JavaDoc注释,使用@return标签来描述方法的返回值。例如,如果一个方法返回一个字符串,我们可以这样描述: /** * 获取欢迎消息。 * * @return 欢迎消息字符串。 */ public String getWelcomeMessage() { return "Welcome!"; } 在@return标签后面的描述,我们可以指定返回值的类型和其他相关说明,以帮助其他开发人员正确理解如何使用该方法的返回值。 总结: 通过在JavaDoc注释使用@param和@return标签,我们可以自定义参数返回值的描述信息,以帮助其他开发人员理解我们编写的代码的使用方法和返回值的含义。这样能够提高代码的可读性和可维护性,并促进代码的复用和团队协作。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值