用什么注解接收json

解密JSON接收：常用编程语言与框架中的注解指南**

在当今的软件开发中，JSON（JavaScript Object Notation）已成为数据交换的事实标准，无论是前后端交互、API调用还是配置文件，JSON都以其轻量、易读和易于解析的特性广受欢迎，当我们使用各种编程语言和框架开发后端服务时，如何高效地从HTTP请求体、消息队列或其他数据源中接收并解析JSON数据，并将其转换为程序中的对象（如Java中的POJO、Python中的类实例等），是一个核心问题，注解（Annotation）作为一种元数据，提供了一种优雅且高效的方式来实现这一目标,它使得开发者能够以声明式的方式指定如何将JSON数据映射到程序对象。

本文将探讨在不同主流编程语言和框架中，常用的注解及其使用方法,帮助你更好地理解和应用JSON接收技术。

Java 生态中的JSON接收注解

Java生态中有多个优秀的JSON处理库，其中Spring框架内置的Jackson和Fastjson（阿里巴巴）以及Gson（Google）最为常用,它们都提供了丰富的注解来灵活控制JSON的映射。

Jackson (Spring Boot 默认)

Jackson是Java领域最流行的JSON库之一，Spring MVC默认使用它来处理JSON请求和响应。

• @RequestBody:

  • 作用: 用于标注Spring MVC控制器方法的参数，表示该参数的值应该从HTTP请求的请求体（request body）中解析,并且期望的内容类型是JSON。
  • 使用场景: 当前端通过POST、PUT等方法发送JSON数据到后端,后端需要将其映射为一个Java对象时。
  • 示例:

    @PostMapping("/users")
    public ResponseEntity<String> createUser(@RequestBody User user) {
        // user对象会自动将请求体中的JSON数据映射而来
        return ResponseEntity.ok("User created: " + user.getName());
    }

    假设请求体为：{"name":"John Doe", "email":"john@example.com"}，那么User类需要有对应的name和email字段。

• @JsonProperty:

  • 作用: 用于Java类的字段或方法上，指定JSON属性名与Java字段名之间的映射关系，当JSON中的键名与Java字段名不一致时,此注解非常有用。

  • 示例:

    public class User {
        @JsonProperty("user_name")
        private String name;
        @JsonProperty("user_email")
        private String email;
        // getters and setters
    }

    这样，JSON中的"user_name"就会被映射到name字段。

• @JsonIgnore:

  • 作用: 用于标记字段或方法，表示该字段在序列化和反序列化时应该被忽略,不参与JSON数据的映射。
  • 示例:

    public class User {
        private String name;
        @JsonIgnore
        private String password; // 密码不会被JSON序列化或反序列化
        // getters and setters
    }

• @JsonFormat:

  • 作用: 用于格式化日期、数字等类型的字段,使其与JSON中的字符串表示形式进行转换。
  • 示例:

    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    private Date createTime;

Fastjson (阿里巴巴)

Fastjson是另一个在国内广泛使用的JSON库，其注解与Jackson有相似之处,但也有自己的特点。

• @JSONField:

  • 作用: Fastjson中用于字段映射的核心注解，可以指定JSON字段名、是否序列化/反序列化、格式等。

  • 示例:

    public class User {
        @JSONField(name = "user_name")
        private String name;
        @JSONField(serialize = false) // 序列化为JSON时忽略此字段
        private String password;
        @JSONField(format = "yyyy-MM-dd")
        private Date birthday;
        // getters and setters
    }

Gson (Google)

Gson是Google推出的JSON库，虽然注解不如Jackson和Fastjson丰富,但也提供了基本的映射支持。

• @SerializedName:
  • 作用: 类似于Jackson的@JsonProperty,用于指定JSON中使用的字段名。
  • 示例:

    public class User {
        @SerializedName("user_name")
        private String name;
        // getters and setters
    }

.NET 生态中的JSON接收注解

在.NET中，处理JSON主要依靠System.Text.Json（现代.NET推荐）和Newtonsoft.Json（广泛使用的第三方库）。

System.Text.Json

• [FromBody]:

  • 作用: 在ASP.NET Core MVC中，用于标记控制器方法的参数，表示该参数应从HTTP请求体中绑定,通常为JSON格式。
  • 示例:

    [HttpPost("users")]
    public IActionResult CreateUser([FromBody] User user)
    {
        // user对象从JSON请求体反序列化而来
        return Ok($"User created: {user.Name}");
    }

• [JsonPropertyName]:

  • 作用: 指定JSON属性名与.NET属性名之间的映射。
  • 示例:

    public class User
    {
        [JsonPropertyName("user_name")]
        public string Name { get; set; }
    }

• [JsonIgnore]:

  • 作用: 在序列化或反序列化时忽略该属性。
  • 示例:

    public class User
    {
        public string Name { get; set; }
        [JsonIgnore]
        public string Password { get; set; }
    }

Newtonsoft.Json (Json.NET)

• [JsonObject] / [JsonProperty]:

  • 作用: [JsonObject]用于类，[JsonProperty]用于属性,指定JSON属性名。
  • 示例:

    public class User
    {
        [JsonProperty("user_name")]
        public string Name { get; set; }
    }

• [JsonIgnore]:

  • 作用: 忽略属性，与System.Text.Json中的用法一致。

Python 生态中的JSON接收处理

Python中处理JSON主要使用内置的json模块，以及像pydantic和dataclasses这样的库来提供更结构化和类型化的数据绑定，虽然它们不完全是“注解”,但提供了类似的声明式机制。

使用 json 模块 (手动解析)

对于简单的JSON数据，可以直接使用json.loads()将JSON字符串转换为字典,然后手动赋值给对象。

import json
class User:
    def __init__(self, name, email):
        self.name = name
        self.email = email
json_str = '{"name": "John Doe", "email": "john@example.com"}'
data = json.loads(json_str)
user = User(data['name'], data['email'])

使用 pydantic (推荐，提供类似注解的验证)

Pydantic允许你使用Python类型提示和验证器来定义数据模型，它内部会处理JSON的解析和验证，可以看作是一种更高级的“声明式”映射。

from pydantic import BaseModel, EmailStr
class User(BaseModel):
    name: str
    email: EmailStr
json_str = '{"name": "John Doe", "email": "john@example.com"}'
user = User.parse_raw(json_str)  # 类似注解的自动映射和验证
print(user.name)

Pydantic的BaseModel会自动将JSON字段映射到模型字段，并支持类型验证、数据转换等功能。

使用 dataclasses + json 模块

Python 3.7+的dataclasses可以简化类的定义，结合json模块的dataclass_decoder可以实现类似效果。

from dataclasses import dataclass
import json
@dataclass
class User:
    name: str
    email: str
json_str = '{"name": "John Doe", "email": "john@example.com"}'
data = json.loads(json_str, object_hook=lambda d: User(**d))
user = data
print(user.name)

其他语言中的简述

• JavaScript/TypeScript: 在前端或Node.js中，通常直接使用JSON.parse()将JSON字符串转换为对象（JavaScript）或接口（TypeScript），TypeScript的接口提供了一种类型化的契约,但不涉及运行时的注解解析。
• Go: Go语言中使用encoding/json包，通过结构体的标签（tags）来实现JSON字段的映射，例如json:"name"。

  type User struct {
      Name  string `json:"name"`
      Email string `json