Java对象属性名和属性值转字符串

Java对象属性名和属性值转字符串

需求

以高德行政区域查询API为例，调用该接口时参数需要拼接在API后面进行请求，然而本人是使用RestTemplate进行请求，将这个API所需要的参数封装成一个Java对象，需要传什么参数，只需要给对象赋值即可

@Data
public class AmapParam {
    private String key;
    private String keywords;
    private Integer subdistrict;
    private Integer page;
    private Integer offset;
    private String extensions;
    private String filter;
    private String callback;
    private String output;
}    

方案一 反射

import java.lang.reflect.Field;
import java.util.ArrayList;
import java.util.List;

/**
 1. url参数拼接工具类
 2.  3. @author ALiang
 4. Created on 2024/5/24
 */
public class EntityUtils {
    public static String buildQueryString(Object entity) {
        List<String> keyValuePairs = new ArrayList<>();
        try {
            Class<?> clazz = entity.getClass();
            Field[] fields = clazz.getDeclaredFields();
            for (Field field : fields) {
                field.setAccessible(true);
                Object value = field.get(entity);
                if (value != null) {
                    String key = field.getName();
                    String pair = key + "=" + value.toString();
                    keyValuePairs.add(pair);
                }
            }
        } catch (IllegalAccessException e) {
            e.printStackTrace();
        }
        return String.join("&", keyValuePairs);
    }
}

1. 首先，创建一个新的 ArrayList 对象 keyValuePairs 来存储每个属性的键值对。
2. 获取传入对象的类型 clazz。
3. 使用 clazz.getDeclaredFields() 方法获取对象的所有属性 fields。
4. 遍历每个属性 field：
   使用 field.setAccessible(true) 设置属性为可访问状态。
   使用 field.get(entity) 获取属性的值 value。
   如果 value 不为 null，则将属性名 key 和属性值 value.toString() 拼接成一个键值对字符串 pair，并将其添加到 keyValuePairs 列表中。
5. 最后，使用 String.join(“&”, keyValuePairs) 将 keyValuePairs 列表中的所有键值对用 & 符号连接起来，生成最终的查询字符串。

        AmapParam amapParam = new AmapParam();
        amapParam.setKey(key);
        String queryString = EntityUtils.buildQueryString(amapParam);
        String url = "https://restapi.amap.com/v3/config/district?" + queryString;
        HashMap<String, Object> responseBody = restTemplate.getForObject(url, HashMap.class);
        String status = (String) responseBody.get("status");
        if (StringUtils.isBlank(status) || "0".equals(status)) {
            LOGGER.warn("国家-高德行政区域查询失败：https://restapi.amap.com/v3/config/district,key:{}", amapParam.getKey());
            return;
        }
        // 调用接口成功
        ArrayList<HashMap<String, Object>> countryResult = (ArrayList<HashMap<String, Object>>) responseBody.get("districts");
        if (countryResult.isEmpty()) {
            return;
        }
        HashMap<String, Object> countryMap = countryResult.get(0);
        // 获取所有省份数据
        ArrayList<HashMap<String, Object>> provinceResult = (ArrayList<HashMap<String, Object>>) countryMap.get("districts");
        if (provinceResult.isEmpty()) {
            return;
        }

方案二 JSON

import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.JSONObject;
import java.lang.reflect.Field;

public class ObjectUtil {
    public static String getObjectParams(Object obj) {
        if (obj == null) {
            return "";
        }
        
        JSONObject jsonObject = (JSONObject) JSON.toJSON(obj);
        
        StringBuilder sb = new StringBuilder();
        for (String key : jsonObject.keySet()) {
            Object value = jsonObject.get(key);
            if (value == null) {
                continue;
            }
            if (sb.length() > 0) {
                sb.append("&");
            }
            sb.append(key).append("=").append(value);
        }
        
        return sb.toString();
    }
    
    // 示例主方法
    public static void main(String[] args) {
        // 示例实体类
        class Person {
            private String name;
            private int age;
            private String email;

            // 构造函数和getter/setter
            public Person(String name, int age, String email) {
                this.name = name;
                this.age = age;
                this.email = email;
            }

            public String getName() {
                return name;
            }

            public void setName(String name) {
                this.name = name;
            }

            public int getAge() {
                return age;
            }

            public void setAge(int age) {
                this.age = age;
            }

            public String getEmail() {
                return email;
            }

            public void setEmail(String email) {
                this.email = email;
            }
        }

        // 测试代码
        Person person = new Person("John Doe", 30, "john.doe@example.com");
        String params = getObjectParams(person);
        System.out.println(params);  // 输出: name=John Doe&age=30&email=john.doe@example.com
    }
}

以上方案仅对实体类属性为基本数据类型有效