Hutool 中 @alias 注解的使用及原理

co松柏

于 2024-12-04 19:39:37 发布

阅读量971

点赞数 3

文章标签：后端 Java Hutool

本文链接：https://blog.youkuaiyun.com/weixin_52258854/article/details/144248054

版权

欢迎关注公众号 co松柏，获取联系方式学习交流

Hi，我是松柏。

对于 Hutool，Java 开发应该都不陌生，非常简单易用的一个工具包，我自己在开发中像发送网络请求、字符串、集合操作也是很经常用到，今天要说的内容就跟其中的对象转 json 工具类有关。

事情是这样的，我需要对接一个三方的 API，这个 API 接收的请求参数大概是这样的：

{
  "file_url": "xxx"
  "file_name": "xxx"
}

那我在使用的时候，就会定义一个对应的实体类来处理，像这样：

@Data
public class RequestParam {
    private String fileUrl;
    private String fileName;
}

然后通过工具类把请求发出去：

public static void main(String[] args) {
    String requestParam = JSONUtil.toJsonStr(new RequestParam());
    String responseBody = HttpUtil.post("xxx.com", requestParam);
}

不出意外，这个请求就要失败了，因为这个 API 接收的参数命名是下划线格式，而我们的请求参数里是驼峰格式，那怎么办呢？

最简单的方法，把实体类的命名改成下划线格式不就行了。

但是这样并不符合 Java 的命名规范，不那么优雅，而且这种问题一般工具类会有相应的处理措施，于是我来到了官方文档，果然找到了相关内容：@alias 注解，那我们就来试下他的效果：

@Data
public class RequestParam {
    @Alias("file_url")
    private String fileUrl;
    @Alias("file_name")
    private String fileName;
    public static void main(String[] args) {
        RequestParam requestParam1 = new RequestParam();
        requestParam1.setFileUrl("111");
        requestParam1.setFileUrl("222");
        String requestParam = JSONUtil.toJsonStr(new RequestParam());
        System.out.println(requestParam);
    }
}

// 输出
{"file_url":"111","file_name":"222"}