转换格式属性配置

首先,我们需要对Json对象转换自定义些常用配置属性,封装成适合项目接口规则的工具类。代码如下:

  1. @Slf4j
  2. public class JsonUtil {
  3. private static ObjectMapper objectMapper = new ObjectMapper();
  4. // 日起格式化
  5. private static final String STANDARD_FORMAT = "yyyy-MM-dd HH:mm:ss";
  6. static {
  7. //对象的所有字段全部列入
  8. objectMapper.setSerializationInclusion(JsonInclude.Include.ALWAYS);
  9. //取消默认转换timestamps形式
  10. objectMapper.configure(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS,false);
  11. //忽略空Bean转json的错误
  12. objectMapper.configure(SerializationFeature.FAIL_ON_EMPTY_BEANS,false);
  13. //所有的日期格式都统一为以下的样式,即yyyy-MM-dd HH:mm:ss
  14. objectMapper.setDateFormat(new SimpleDateFormat(STANDARD_FORMAT));
  15. //忽略 在json字符串中存在,但是在java对象中不存在对应属性的情况。防止错误
  16. objectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES,false);
  17. }
  18. }

对象与Json字符串之间的转换

一般对象与字符串之间的转换最为常用,代码实现如下:

  1. /**
  2. * 对象转Json格式字符串
  3. * @param obj 对象
  4. * @return Json格式字符串
  5. */
  6. public static <T> String obj2String(T obj) {
  7. if (obj == null) {
  8. return null;
  9. }
  10. try {
  11. return obj instanceof String ? (String) obj : objectMapper.writeValueAsString(obj);
  12. } catch (JsonProcessingException e) {
  13. log.warn("Parse Object to String error : {}", e.getMessage());
  14. return null;
  15. }
  16. }
  17. /**
  18. * 对象转Json格式字符串(格式化的Json字符串)
  19. * @param obj 对象
  20. * @return 美化的Json格式字符串
  21. */
  22. public static <T> String obj2StringPretty(T obj) {
  23. if (obj == null) {
  24. return null;
  25. }
  26. try {
  27. return obj instanceof String ? (String) obj : objectMapper.writerWithDefaultPrettyPrinter().writeValueAsString(obj);
  28. } catch (JsonProcessingException e) {
  29. log.warn("Parse Object to String error : {}", e.getMessage());
  30. return null;
  31. }
  32. }
  33. /**
  34. * 字符串转换为自定义对象
  35. * @param str 要转换的字符串
  36. * @param clazz 自定义对象的class对象
  37. * @return 自定义对象
  38. */
  39. public static <T> T string2Obj(String str, Class<T> clazz){
  40. if(StringUtils.isEmpty(str) || clazz == null){
  41. return null;
  42. }
  43. try {
  44. return clazz.equals(String.class) ? (T) str : objectMapper.readValue(str, clazz);
  45. } catch (Exception e) {
  46. log.warn("Parse String to Object error : {}", e.getMessage());
  47. return null;
  48. }
  49. }

上述三个方法实现起来也比较简单,满足了绝大多数业务接口开发,不过聪明的你们也想到了,在字符串转换对象的时候会存在一个坑,不用我说,你们也知道,就是在字符串与集合对象转换时会存在问题,那应该如何解决呢?

集合对象与Json字符串之间的转换

  1. public static <T> T string2Obj(String str, TypeReference<T> typeReference) {
  2. if (StringUtils.isEmpty(str) || typeReference == null) {
  3. return null;
  4. }
  5. try {
  6. return (T) (typeReference.getType().equals(String.class) ? str : objectMapper.readValue(str, typeReference));
  7. } catch (IOException e) {
  8. log.warn("Parse String to Object error", e);
  9. return null;
  10. }
  11. }
  12. public static <T> T string2Obj(String str, Class<?> collectionClazz, Class<?>... elementClazzes) {
  13. JavaType javaType = objectMapper.getTypeFactory().constructParametricType(collectionClazz, elementClazzes);
  14. try {
  15. return objectMapper.readValue(str, javaType);
  16. } catch (IOException e) {
  17. log.warn("Parse String to Object error : {}" + e.getMessage());
  18. return null;
  19. }
  20. }

测试用例

实体类

  1. public class User {
  2. private Integer id;
  3. private String email;
  4. // 省略 set 和 get 方法
  5. }

测试代码

  1. @Slf4j
  2. public class JsonUtilTest {
  3. public static void main(String[] args) {
  4. User user1 = new User();
  5. user1.setId(1);
  6. user1.setEmail("chenhaifei@163.com");
  7. String userJsonstr = JsonUtil.obj2String(user1);
  8. String userJsonPretty = JsonUtil.obj2StringPretty(user1);
  9. log.info("userJson: {}", userJsonPretty);
  10. User user2 = JsonUtil.string2Obj(userJsonstr, User.class);
  11. user2.setId(2);
  12. user2.setEmail("tianxiaorui@126.com");
  13. List<User> userList = new ArrayList<>();
  14. userList.add(user1);
  15. userList.add(user2);
  16. String userListJson = JsonUtil.obj2String(userList);
  17. List<User> userListBean = JsonUtil.string2Obj(userListJson, new TypeReference<List<User>>() {});
  18. if (userListBean != null) {
  19. userListBean.forEach(user -> {
  20. System.out.println(user.getId() + " : " + user.getEmail());
  21. });
  22. }
  23. List<User> userListBean2 = JsonUtil.string2Obj(userListJson, List.class, User.class);
  24. if (userListBean2 != null) {
  25. userListBean2.forEach(user -> {
  26. System.out.println(user.getId() + " : " + user.getEmail());
  27. });
  28. }
  29. }
  30. }

其他json工具类

Google的Gson

Gson是目前功能最全的Json解析神器,Gson的应用主要为toJson与fromJson两个转换函数,无依赖,不需要例外额外的jar,能够直接跑在JDK上。
而在使用这种对象转换之前需先创建好对象的类型以及其成员才能成功的将JSON字符串成功转换成相对应的对象。
类里面只要有get和set方法,Gson完全可以将复杂类型的json到bean或bean到json的转换,是JSON解析的神器。
Gson在功能上面无可挑剔,但是性能上面比FastJson有所差距。
1. bean转换json:toJson

  1. Gson gson = new Gson();
  2. String json = gson.toJson(obj);
  1. json转换bean:fromJson
    1. Gson gson = new Gson();
    2. String json = "{\"id\":\"2\",\"name\":\"Json技术\"}";
    3. Book book = gson.fromJson(json, Book.class);
  2. json转换复杂的bean,比如List,Set : fromJson
    1. // 将json转换成复杂类型的bean,需要使用TypeToken
    2. Gson gson = new Gson();
    3. String json = "[{\"id\":\"1\",\"name\":\"Json技术\"},{\"id\":\"2\",\"name\":\"java技术\"}]";
    4. // 将json转换成List
    5. List list = gson.fromJson(json, new TypeToken<List>() {}.getType());
    6. // 将json转换成Set
    7. Set set = gson.fromJson(json, new TypeToken<Set>() {}.getType());
  3. 通过json对象直接操作json以及一些json的工具
    1. GsonBuilder gsonBuilder = new GsonBuilder();
    2. ResponseData responseData = gsonBuilder.create().fromJson(result, ResponseData.class);

    阿里巴巴的Fastjson

    Fastjson是一个Java语言编写的高性能的JSON处理器,由阿里巴巴公司开发。
    无依赖,不需要例外额外的jar,能够直接跑在JDK上。
    FastJson在复杂类型的Bean转换Json上会出现一些问题,可能会出现引用的类型,导致Json转换出错,需要制定引用。
    FastJson采用独创的算法,将parse的速度提升到极致,超过所有json库。
    1. bean转换json: toJSONString
    1. // 将对象转换成格式化的json
    2. JSON.toJSONString(obj, true);
    3. // 将对象转换成非格式化的json
    4. JSON.toJSONString(obj, false);
    5. // 对于复杂类型的转换,对于重复的引用在转成json串后在json串中出现引用的字符,比如
    6. // $ref":"$[0].books[1]
    7. Student stu = new Student();
    8. Set books= new HashSet();
    9. Book book = new Book();
    10. books.add(book);
    11. stu.setBooks(books);
    12. List list = new ArrayList();
    13. for(int i=0;i<5;i++) {
    14. list.add(stu);
    15. }
    16. String json = JSON.toJSONString(list, true);
    map转json
    1. JSONObject json = JSONObject.parseObject(JSON.toJSONString(mainBrandMap));
  4. json转换bean:parseObject
    1. String json = "{\"id\":\"2\",\"name\":\"Json技术\"}";
    2. Book book = JSON.parseObject(json, Book.class);
  5. json转换复杂的bean,比如List,Map:parseObject
    1. String json = "[{\"id\":\"1\",\"name\":\"Json技术\"},{\"id\":\"2\",\"name\":\"java技术\"}]";
    2. // 将json转换成List
    3. List list = JSON.parseObject(json, new TypeReference<ARRAYLIST>(){});
    4. // 将json转换成Set
    5. Set set = JSON.parseObject(json, new TypeReference<HASHSET>(){});
  6. 通过json对象直接操作json
    1. String propertyName = 'id';
    2. String propertyValue = "";
    3. String json = "{\"id\":\"1\",\"name\":\"Json技术\"}";
    4. JSONObject obj = JSON.parseObject(json);
    5. propertyValue = obj.get(propertyName));

    如何选择

    在项目选型的时候可以使用Google的Gson和阿里巴巴的FastJson两种并行使用,
    如果只是功能要求,没有性能要求,可以使用google的Gson,
    如果有性能上面的要求可以使用Gson将bean转换json确保数据的正确,使用FastJson将Json转换Bean
    1. //解析json报文
    2. ServletInputStream inputStream = request.getInputStream();
    3. BufferedReader reader = new BufferedReader(new InputStreamReader(inputStream,"UTF-8"));
    4. StringBuffer buffer = new StringBuffer();
    5. String inputStr = "";
    6. while ((inputStr = reader.readLine())!= null) {
    7. buffer.append(inputStr);
    8. }
    9. String inputJson = buffer.toString();
    10. inputJson = URLDecoder.decode(inputJson, "GBK");
    11. JSONObject jsonObject = new JSONObject(inputJson);
    12. JSONObject jsonObject2 = null;
    13. String businessNo = jsonObject.getString("BusinessNo").trim();
    14. if (businessNo != null && "P".equals(businessNo.substring(0, 1))) {
    15. JSONArray jasonArray = jsonObject.getJSONArray("FieldList");
    16. for (int i = 0; i < jasonArray.length(); i++) {
    17. jsonObject2 = jasonArray.getJSONObject(i);
    18. prpScoreDataModifyDto = new PrpScoreDataModifyDto();
    19. prpScoreDataModifyDto.setSid(dbPrpScoreDataModify.getSid());
    20. prpScoreDataModifyDto.setBusinessNo(businessNo);
    21. prpScoreDataModifyDto.setPolicyNo(businessNo);
    22. prpScoreDataModifyDto.setInputDate(new DateTime(new Date(), DateTime.YEAR_TO_SECOND));
    23. prpScoreDataModifyDto.setStatus("0");
    24. prpScoreDataModifyDto.setTarField(jsonObject2.getString("TarField").trim());
    25. prpScoreDataModifyDto.setNewValue(jsonObject2.getString("NewValue").trim());
    26. prpScoreDataModifyDto.setOldValue(jsonObject2.getString("OldValue").trim());
    27. }
    28. }