Google Gson 属性重命名(SerializedName 注解)

默认情况下解析和生成 JSON 字符串要求键名称和 POJO 类的属性名一一对应，实际应用中常常出现不一致现象，

如期望字符串：{“account”:”admin”,”password”:”123456”,”age”:30}

实际字符串：{“account”:”admin”,”code”:”123456”,”age”:30}

Gson 使用 @SerializedName 注解解决 JSON 字符串键名称和 POJO 类属性名不对应的问题

示例

1 POJO 类

1. 
   
2. import com.google.gson.annotations.SerializedName;
4. public class User {
6. private String account;
8. @SerializedName("code")
9. private String password;
11. private String name;
13. private int age;
15. public String getAccount() {
16. return account;
17. }
19. public void setAccount(String account) {
20. this.account = account;
21. }
23. public String getPassword() {
24. return password;
25. }
27. public void setPassword(String password) {
28. this.password = password;
29. }
31. public String getName() {
32. return name;
33. }
35. public void setName(String name) {
36. this.name = name;
37. }
39. public int getAge() {
40. return age;
41. }
43. public void setAge(int age) {
44. this.age = age;
45. }
47. @Override
48. public String toString() {
49. return "User [account=" + account + ", password=" + password + ", name=" + name + ", age=" + age + "]";
50. }
52. }

• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8
• 9
• 10
• 11
• 12
• 13
• 14
• 15
• 16
• 17
• 18
• 19
• 20
• 21
• 22
• 23
• 24
• 25
• 26
• 27
• 28
• 29
• 30
• 31
• 32
• 33
• 34
• 35
• 36
• 37
• 38
• 39
• 40
• 41
• 42
• 43
• 44
• 45
• 46
• 47
• 48
• 49
• 50
• 51

2 单元测试

1. 
   
2. @Test
3. public void test() {
4. Gson gson = new Gson();
6. String userStr = "{\"account\":\"admin\",\"code\":\"123456\",\"age\":30}";
8. User user = gson.fromJson(userStr, User.class);
10. assertEquals(user.getAccount(), "admin");
11. assertEquals(user.getPassword(), "123456");
12. assertEquals(user.getAge(), 30);
13. }

• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8
• 9
• 10
• 11
• 12

如果存在多个需要解析的 JSON 字符串，每个字符串的键名称各不相同，但实际上对应的都是 POJO 对象的同一个属性，如

{“account”:”admin”,”password”:”123456”,”age”:30}

{“account”:”admin1”,”code”:”000000”,”age”:20}

{“account”:”adminX”,”xxx”:”aaaaaa”,”age”:40}

{“account”:”adminY”,”yyy”:”bbbbbb”,”age”:45}

{“account”:”adminZ”,”zzz”:”cccccc”,”age”:50}

解决方法：

1 修改 POJO 类

1. 
   
2. import com.google.gson.annotations.SerializedName;
4. public class User {
6. private String account;
8. @SerializedName(value = "password", alternate = {"code", "xxx", "yyy", "zzz"})
9. private String password;
11. private String name;
13. private int age;
15. public String getAccount() {
16. return account;
17. }
19. public void setAccount(String account) {
20. this.account = account;
21. }
23. public String getPassword() {
24. return password;
25. }
27. public void setPassword(String password) {
28. this.password = password;
29. }
31. public String getName() {
32. return name;
33. }
35. public void setName(String name) {
36. this.name = name;
37. }
39. public int getAge() {
40. return age;
41. }
43. public void setAge(int age) {
44. this.age = age;
45. }
47. @Override
48. public String toString() {
49. return "User [account=" + account + ", password=" + password + ", name=" + name + ", age=" + age + "]";
50. }
52. }

• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8
• 9
• 10
• 11
• 12
• 13
• 14
• 15
• 16
• 17
• 18
• 19
• 20
• 21
• 22
• 23
• 24
• 25
• 26
• 27
• 28
• 29
• 30
• 31
• 32
• 33
• 34
• 35
• 36
• 37
• 38
• 39
• 40
• 41
• 42
• 43
• 44
• 45
• 46
• 47
• 48
• 49
• 50
• 51

2 单元测试

1. 
   
2. @Test
3. public void test() {
4. Gson gson = new Gson();
6. String userStr = "{\"account\":\"admin\",\"password\":\"123456\",\"age\":30}";
7. User user = gson.fromJson(userStr, User.class);
8. assertEquals(user.getAccount(), "admin");
9. assertEquals(user.getPassword(), "123456");
10. assertEquals(user.getAge(), 30);
12. userStr = "{\"account\":\"admin1\",\"code\":\"000000\",\"age\":20}";
13. user = gson.fromJson(userStr, User.class);
14. assertEquals(user.getAccount(), "admin1");
15. assertEquals(user.getPassword(), "000000");
16. assertEquals(user.getAge(), 20);
18. userStr = "{\"account\":\"adminX\",\"xxx\":\"aaaaaa\",\"age\":40}";
19. user = gson.fromJson(userStr, User.class);
20. assertEquals(user.getAccount(), "adminX");
21. assertEquals(user.getPassword(), "aaaaaa");
22. assertEquals(user.getAge(), 40);
24. userStr = "{\"account\":\"adminY\",\"yyy\":\"bbbbbb\",\"age\":45}";
25. user = gson.fromJson(userStr, User.class);
26. assertEquals(user.getAccount(), "adminY");
27. assertEquals(user.getPassword(), "bbbbbb");
28. assertEquals(user.getAge(), 45);
30. userStr = "{\"account\":\"adminZ\",\"zzz\":\"cccccc\",\"age\":50}";
31. user = gson.fromJson(userStr, User.class);
32. assertEquals(user.getAccount(), "adminZ");
33. assertEquals(user.getPassword(), "cccccc");
34. assertEquals(user.getAge(), 50);
35. }