@RequestParam
@RequestParam: RequestHeader、つまりリクエスト ヘッダーから受け取ります。通常、GET リクエストに使用されます。例: http://localhost:8080/hello/name=admin&age=18
@Target({ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface RequestParam {
@AliasFor("name")
String value() default "";
@AliasFor("value")
String name() default "";
boolean required() default true;
String defaultValue() default "\n\t\t\n\t\t\n\ue000\ue001\ue002\n\t\t\t\t\n";
}
GETリクエスト
@GetMapping("/hello")
public String hello(@RequestParam(name = "id") Long id){
System.out.println("hello " + id);
return "hello message";
}
@RequestParam は、エンコードされた
Content-Type
コンテンツを処理するために使用され、デフォルトでこのプロパティに設定されますapplication/x-www-form-undencoded
Content-Type
@RequestParam は、POST、DELETE、その他のリクエストなど、他のタイプのリクエストにも使用できます。
POST リクエスト
@RequestParam は としてエンコードされたコンテンツContent-Type
を処理するapplication/x-www-form-urlencoded
、postman では、本文のタイプを as として選択する必要がx-www-form-urlencoded
ありContent-Type
ますapplication/x-www-form-urlencoded
。以下に示すように:
@PostMapping("/save")
public String hello(@RequestParam(name = "id") Long id,
@RequestParam("name") String name,
@RequestParam("password") String password){
System.out.println(user);
return "hello message";
}
フロントデスクから渡されたパラメーターが 3 つではなく 10 である場合、引き続き @RequestParam を使用してリクエストパラメーターを受け取ると、10 個の @RequestParam が必要になり、コードの可読性が非常に悪くなり、パラメーターの型が同様に、非常にエラーが発生しやすいです。エンティティクラスを使用して渡されたパラメータを受け取りますが、@RequestParam はエンティティクラスを直接渡す方法をサポートしていません
@Data
public class User {
@NotNull(message = "id不能为空")
private Long id;
@NotBlank(message = "名字不能为空")
private String name;
@NotBlank(message = "密码不能为空")
private String password;
}
// @RequestParam 不支持直接传递实体类的方式,所以可以在实体类中做数据校验,使用 @Validated 注解使得作用在实体类属性上的注解生效
@PostMapping("/save")
public String save(@Validated User user){
System.out.println(user);
return "hello success";
}
// console result: User(id=110, name=admin, password=123456)
json
代わりに文字列を 使用して値を渡す場合は、タイプを に設定application/json
します。[送信] をクリックすると、エラーが報告され、バックグラウンドで値を受信できなくなります。null
// console result: User(id=null, name=null, password=null)
@RequestBody
アノテーション @RequestBody によって受け取られるパラメーターは、requestBody、つまりリクエスト本体から取得されます。通常、次のようなContent-Type: application/x-www-form-urlencoded
エンコードされてapplication/json
。 、application/xml
およびその他の種類のデータ。
データのタイプに関する限りapplication/json
、アノテーション @RequestBody を使用して、ボディ内のすべての json データをバックエンドに転送すると、バックエンドがそれを解析します。
@PostMapping("/saveBatch")
public String saveBatch(@RequestBody @Validated List<User> list){
list.forEach(System.out::println);
return "saveBatch success";
}
// console result:
// User(id=1, name=admin, password=123456)
// User(id=2, name=cheny, password=cheny)
マップに渡される
@PostMapping("/listMap")
public String saveMap(@RequestBody List<Map<String, String>> listMap){
for (Map<String, String> map : listMap) {
System.out.println(map);
}
return "listMap success";
}
// console result:
// {id=1, name=admin}
// {id=2, age=18}
要約する
アノテーション @RequestParam が受け取るパラメーターは、requestHeader、つまりリクエストヘッダーから取得されます。通常は GET リクエストに使用されますが、POST、DELETE などの他のタイプのリクエストも使用できます。
アノテーション @RequestBody によって受け取られるパラメーターは、requestBody、つまりリクエスト本体から取得されます。通常、次のようなContent-Type: application/x-www-form-urlencoded
エンコードされてapplication/json
。 、application/xml
およびその他の種類のデータ。通常、POST、DELETE などのリクエスト データの受信に使用されますが、GET タイプも適用できます。
- GET リクエストでは、@RequestBody は使用できません。
- POST リクエストでは @RequestBody と @RequestParam を使用できますが、@RequestBody を使用する場合はパラメーター変換の構成を統一する必要があります。
- 複数の @RequestParam を使用してデータを取得できますが、@RequestBody は使用できません
たとえば、SpringMVC に設定された HttpMessageConverters 処理スタックで、Date を「yyyy-MM-dd」に変換するなどの json 変換の形式を指定し、パラメータ受け取りオブジェクトに含まれるフィールドが Date 型の場合、それを行うことができます。形式は年月日で、時分秒は渡せません。インターフェースが異なるため、そのパラメーターは時間パラメーターの形式要件が異なる場合があります。そのため、クライアントが同僚にパラメーターの形式について少し混乱させる可能性があるため、スケーラビリティは高くありません。
@RequestParam を使用してパラメーターを受け入れる場合、パラメーターを受け入れるモデルで @DateFormat を設定して、時間パラメーターを受け入れるために必要な形式を指定できます。
また、@RequestBody で受け付けたパラメータを Servlet で変換せずに、リクエスト オブジェクトの Param パラメータ セットに配置する、@RequestParam が可能です。
要約すると、一般に、@RequestParam アノテーションを使用して Http 要求パラメーターを受け入れることをお勧めします。
参考文献
@RequestParam および @RequestBody アノテーションの使用シナリオ - Tencent Cloud Developer Community - Tencent Cloud