java如何引入json

Java中如何引入和使用JSON

在Java开发中，JSON（JavaScript Object Notation）作为一种轻量级的数据交换格式，被广泛应用于前后端数据交互、配置文件存储、API响应等场景，本文将详细介绍在Java中如何引入和使用JSON，包括常用的库、基本操作以及实际应用示例。

选择JSON处理库

Java中有多种JSON处理库可供选择,其中最常用的包括：

Jackson：功能强大，性能优秀，Spring Framework默认使用
Gson：Google开发，简单易用
org.json：轻量级，API简洁
Fastjson：阿里巴巴开发，性能优异（但存在安全漏洞,新项目不推荐）

本文以Jackson和Gson为例进行介绍,因为它们是目前最流行且维护良好的选择。

引入Jackson库

Maven依赖

在pom.xml中添加以下依赖：

<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-databind</artifactId>
    <version>2.13.0</version> <!-- 使用最新版本 -->
</dependency>

基本使用示例

将Java对象转换为JSON字符串

import com.fasterxml.jackson.databind.ObjectMapper;
public class JacksonExample {
    public static void main(String[] args) throws Exception {
        ObjectMapper objectMapper = new ObjectMapper();
        // 创建Java对象
        User user = new User("张三", 25, "zhangsan@example.com");
        // 转换为JSON字符串
        String jsonStr = objectMapper.writeValueAsString(user);
        System.out.println(jsonStr); 
        // 输出: {"name":"张三","age":25,"email":"zhangsan@example.com"}
    }
}
class User {
    private String name;
    private int age;
    private String email;
    // 构造方法、getter和setter省略...
}

将JSON字符串转换为Java对象

String jsonStr = "{\"name\":\"李四\",\"age\":30,\"email\":\"lisi@example.com\"}";
User user = objectMapper.readValue(jsonStr, User.class);
System.out.println(user.getName()); // 输出: 李四

引入Gson库

Maven依赖

在pom.xml中添加以下依赖：

<dependency>
    <groupId>com.google.code.gson</groupId>
    <artifactId>gson</artifactId>
    <version>2.8.9</version> <!-- 使用最新版本 -->
</dependency>

基本使用示例

将Java对象转换为JSON字符串

import com.google.gson.Gson;
public class GsonExample {
    public static void main(String[] args) {
        Gson gson = new Gson();
        // 创建Java对象
        User user = new User("王五", 28, "wangwu@example.com");
        // 转换为JSON字符串
        String jsonStr = gson.toJson(user);
        System.out.println(jsonStr);
        // 输出: {"name":"王五","age":28,"email":"wangwu@example.com"}
    }
    // User类同上...
}

将JSON字符串转换为Java对象

String jsonStr = "{\"name\":\"赵六\",\"age\":35,\"email\":\"zhaoliu@example.com\"}";
User user = gson.fromJson(jsonStr, User.class);
System.out.println(user.getAge()); // 输出: 35

处理复杂JSON结构

处理JSON数组

// JSON数组字符串
String jsonArrayStr = "[{\"name\":\"张三\",\"age\":25},{\"name\":\"李四\",\"age\":30}]";
// 使用Jackson转换为List
ObjectMapper mapper = new ObjectMapper();
List<User> userList = mapper.readValue(jsonArrayStr, 
    new TypeReference<List<User>>() {});
// 使用Gson转换为List
List<User> userList = gson.fromJson(jsonArrayStr, 
    new TypeToken<List<User>>() {}.getType());

处理嵌套JSON对象

String nestedJson = "{\"name\":\"张三\",\"address\":{\"city\":\"北京\",\"street\":\"中关村\"}}";
// 定义嵌套类
class Address {
    private String city;
    private String street;
    // getter和setter...
}
class UserWithAddress {
    private String name;
    private Address address;
    // getter和setter...
}
// 转换
UserWithAddress user = mapper.readValue(nestedJson, UserWithAddress.class);

配置与注解

Jackson注解

Jackson提供了丰富的注解来控制JSON序列化和反序列化行为：

import com.fasterxml.jackson.annotation.*;
public class User {
    @JsonProperty("username") // 指定JSON字段名
    private String name;
    @JsonIgnore // 忽略该字段
    private String password;
    @JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd")
    private Date birthDate;
    @JsonCreator // 自定义构造方法
    public User(@JsonProperty("name") String name) {
        this.name = name;
    }
}

Gson注解

Gson也提供了类似的注解支持：

import com.google.gson.annotations.*;
public class User {
    @SerializedName("username") // 指定JSON字段名
    private String name;
    @Expose(serialize = false) // 反序列化时忽略
    private String password;
    // 其他代码...
}

实际应用场景

RESTful API响应

// Spring MVC控制器示例
@RestController
@RequestMapping("/api/users")
public class UserController {
    @GetMapping("/{id}")
    public ResponseEntity<String> getUserById(@PathVariable int id) {
        User user = userService.findById(id);
        ObjectMapper mapper = new ObjectMapper();
        try {
            String json = mapper.writeValueAsString(user);
            return ResponseEntity.ok(json);
        } catch (JsonProcessingException e) {
            return ResponseEntity.status(500).body("Error processing JSON");
        }
    }
}

读取配置文件

// 读取JSON配置文件
ObjectMapper mapper = new ObjectMapper();
try {
    Config config = mapper.readValue(new File("config.json"), Config.class);
    // 使用配置...
} catch (IOException e) {
    e.printStackTrace();
}