【springMVC】RESTFulとHttpMessageConverter

モバイル 2023-04-10 02:50:20 訪問数: null

1.RESTful

プレゼンテーション層のリソース状態転送である REST (Representational State Transfer) は、要求パラメーターを要求パスに変換するソフトウェア アーキテクチャ スタイルまたはソフトウェア設計スタイルです。

具体的には、HTTP プロトコルには、操作モードを示す 4 つの動詞 (GET、POST、PUT、DELETE) があります。
これらは 4 つの基本操作に対応しています。GET はリソースを取得するために使用され、POST は新しいリソースを作成するために使用され、PUT はリソースを更新するために使用され、DELETE はリソースを削除するために使用されます。

REST スタイルは、URL アドレスに統一されたスタイル デザインを使用することを提唱しています。前から後ろまで、各単語はスラッシュで区切られており、リクエスト パラメータは疑問符のキーと値のペアの形式では運ばれません。代わりに、サーバーに送信されるデータは、全体的なスタイルの一貫性を確保するために URL アドレスの一部として使用されます。

コードのデモ

pom.xml の依存関係

  <packaging>war</packaging>
  <dependencies>
    <!--SpringMVC-->
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-webmvc</artifactId>
      <version>5.3.1</version>
    </dependency>
    <!--日志-->
    <dependency>
      <groupId>ch.qos.logback</groupId>
      <artifactId>logback-classic</artifactId>
      <version>1.2.3</version>
    </dependency>
    <!--servletAPI-->
    <dependency>
      <groupId>javax.servlet</groupId>
      <artifactId>javax.servlet-api</artifactId>
      <version>3.1.0</version>
      <scope>provided</scope>
    </dependency>
    <!--Spring与Thymeleaf整合-->
    <dependency>
      <groupId>org.thymeleaf</groupId>
      <artifactId>thymeleaf-spring5</artifactId>
      <version>3.0.12.RELEASE</version>
    </dependency>
  </dependencies>

（1）UserController.java

@Controller
public class UserController {
    /**
     * 使用RESTFul实现对用户信息的操作
     * /user        GET         查询所有用户信息
     * /user/1      GET         根据id查询用户信息
     * /user        POST        添加用户信息
     * /user/1      DELETE      根据id删除用户信息
     * /user        PUT         修改用户信息
     */
    @RequestMapping(value = "/user",method = RequestMethod.GET)
    public String getAllUSer(){
        System.out.println("查询用户信息");
        return "success";
    }
    @RequestMapping(value = "/user/{id}",method = RequestMethod.GET)
    public String getUserById(){
        System.out.println("根据id查询客户信息");
        return "success";
    }
    @RequestMapping(value = "/user",method = RequestMethod.POST)
    public String insertUser(String username,String password){
        System.out.println("添加用户信息："+username+","+password);
        return "success";
    }
    @RequestMapping(value = "user",method = RequestMethod.PUT)
    public String updateUser(String username,String password){
        System.out.println("修改用户信息："+username+","+password);
        return "success";
    }
}

（2）springMVC.xml

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:context="http://www.springframework.org/schema/context"
       xmlns:mvc="http://www.springframework.org/schema/mvc"
       xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
        http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd
        http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc.xsd">
    <!--配置包扫描组件-->
    <context:component-scan base-package="com.jd.mvc.controller"/>
    <!--配置视图解析器-->
    <bean id="viewResolver" class="org.thymeleaf.spring5.view.ThymeleafViewResolver">
        <property name="order" value="1"/>
        <property name="characterEncoding" value="UTF-8"/>
        <property name="templateEngine">
            <bean class="org.thymeleaf.spring5.SpringTemplateEngine">
                <property name="templateResolver">
                    <bean class="org.thymeleaf.spring5.templateresolver.SpringResourceTemplateResolver">
                            <!--视图前缀-->
                            <property name="prefix" value="/WEB-INF/templates/"/>
                        <!--视图后缀-->
                        <property name="suffix" value=".html"/>
                        <property name="templateMode" value="HTML5"/>
                        <property name="characterEncoding" value="UTF-8"/>
                    </bean>
                </property>
            </bean>
        </property>
    </bean>
    <!--配置SpringMVC的视图控制器-->
    <mvc:view-controller path="/" view-name="index"></mvc:view-controller>
    <mvc:view-controller path="/rest_test" view-name="rest_test"></mvc:view-controller>
    <!--开启SpringMVC的注解驱动-->
    <mvc:annotation-driven/>
</beans>

（3）web.xml

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_4_0.xsd"
         version="4.0"
         metadata-complete="true">
    <!--配置编码过滤器，在此之前不能获取任何的请求参数，只要获取请求参数，设置编码方式就无用-->
    <filter>
        <filter-name>CharacterEncodingFilter</filter-name>
        <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
        <!--设置请求的编码-->
        <init-param>
            <param-name>encoding</param-name>
            <param-value>UTF-8</param-value>
        </init-param>
        <!--设置响应的编码-->
        <init-param>
            <param-name>forceResponseEncoding</param-name>
            <param-value>true</param-value>
        </init-param>
    </filter>
    <!--表示对所有的都进行编码，过滤器的执行顺序是根据<filter-mapping>的顺序执行的-->
    <filter-mapping>
        <filter-name>CharacterEncodingFilter</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>
    
    <!--配置HiddenHttpMethodFilter-->
    <filter>
        <filter-name>HiddenHttpMethodFilter</filter-name>
        <filter-class>org.springframework.web.filter.HiddenHttpMethodFilter</filter-class>
    </filter>
    <filter-mapping>
        <filter-name>HiddenHttpMethodFilter</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>
    
    <!--配置SpringMVC的前端控制器-->
    <servlet>
        <servlet-name>DispatcherServlet</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <init-param>
            <param-name>contextConfigLocation</param-name>
            <param-value>classpath:springMVC.xml</param-value>
        </init-param>
        <load-on-startup>1</load-on-startup>
    </servlet>
    <servlet-mapping>
        <servlet-name>DispatcherServlet</servlet-name>
        <url-pattern>/</url-pattern>
    </servlet-mapping>
</web-app>

（4）rest_test.html

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
<a th:href="@{/user}">查询用户信息</a>
<a th:href="@{/user/1}">根据id查询用户信息</a>
<form th:action="@{/user}" method="post">
    用户名：<input type="text" name="username"><br>
    密码：<input type="password" name="password"><br>
    <input type="submit" value="添加">
</form>
<!--要想处理put和delete请求:(1)method设置为post；(2)传输一个请求参数为“_method”-->
<form th:action="@{/user}" method="post">
    <!--该请求参数对客户无用，不需要看到，设置为hidden-->
    <input type="hidden" name="_method" value="PUT">
    用户名：<input type="text" name="username"><br>
    密码：<input type="password" name="password"><br>
    <input type="submit" value="修改">
</form>
</body>
</html>

二、HttpMessageConverter

HttpMessageConverter (メッセージ情報コンバーター): 要求メッセージを Java オブジェクトに変換するか、Java オブジェクトを応答メッセージに変換します。

HttpMessageConverter は、2 つのアノテーションと 2 つのタイプ (@PequestBody、@ResponseBody、RequestEntity、ResponseEntity
1.@RequestBody)を提供します。

@RequestBody can get the request body. You need to set a Formal parameter in the controller method and use @RequestBody to identify it. 現在のリクエストのリクエスト本文は、現在のアノテーションで識別された仮パラメーターに値を割り当てます。

@RequestMapping("/testRequestBody")
public String testRequestBody(@RequestBody String requestBody ){
    System.out.println("requestBody : "+requestBody);
    return "success";
}
<form th:action="@{testRequestBody}" method="post">
    username:<input type="text" name="username"><br>
    username:<input type="password" name="password"><br>
    <input type="submit" value="测试@RequestBody"><br>
</form>

操作結果:

requestBody : username=admin&password=11111

2. RequestEntity
RequestEntity は、コントローラー メソッドの仮パラメーターに設定する必要がある要求メッセージのタイプをカプセル化し、現在の要求の要求メッセージが仮パラメーターに割り当てられ、getHeaders( を介して要求を取得できます。 ) ヘッダー情報、getBody() を使用してリクエスト ボディ情報を取得します。

@RequestMapping("/testRequestEntity")
public String testRequestEntity(RequestEntity<String> requestEntity){
    System.out.println("------------------------------------------");
    System.out.println("请求头："+requestEntity.getHeaders());
    System.out.println("请求体："+requestEntity.getBody());
    System.out.println("------------------------------------------");
    return "success";
}
<form th:action="@{testRequestEntity}" method="post">
    username:<input type="text" name="username"><br>
    username:<input type="password" name="password"><br>
    <input type="submit" value="测试RequestEntity"><br>
</form>

操作結果:

------------------------------------------
请求头：[host:"localhost:8080", connection:"keep-alive", content-length:"29", cache-control:"max-age=0", sec-ch-ua:""Chromium";v="94", "Google Chrome";v="94", ";Not A Brand";v="99"", sec-ch-ua-mobile:"?0", sec-ch-ua-platform:""Windows"", upgrade-insecure-requests:"1", origin:"http://localhost:8080", user-agent:"Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/94.0.4606.81 Safari/537.36", accept:"text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,image/apng,*/*;q=0.8,application/signed-exchange;v=b3;q=0.9", sec-fetch-site:"same-origin", sec-fetch-mode:"navigate", sec-fetch-user:"?1", sec-fetch-dest:"document", referer:"http://localhost:8080/", accept-encoding:"gzip, deflate, br", accept-language:"zh-CN,zh;q=0.9", Content-Type:"application/x-www-form-urlencoded;charset=UTF-8"]
请求体：username=admin&password=11111
------------------------------------------

3. @ResponseBody @ResponseBody は、コントローラのメソッドを識別するために使用され、メソッドの戻り値は、ブラウザに応答するための応答メッセージの応答ボディとして直接使用できます。

@RequestMapping("/testResponseBody")
@ResponseBody
public String testResponseBody() {
    //返回值作为数据响应到浏览器，若没有@ResponseBody则表示响应的视图名
    return "success";
}
<a th:href="@{/testResponseBody}">测试@ResponseBody响应浏览器数据</a><br>

3.Spring MVC 処理 json

ステップ：

(1) ジャクソンの依存関係をインポートする

<!--jackson的依赖，实现@ResponseBody对Json数据的处理-->
<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-databind</artifactId>
    <version>2.12.1</version>
</dependency>

(2) springMVC の設定ファイルでアノテーションドライバーを有効にする

<!--开启SpringMVC的注解驱动-->
<mvc:annotation-driven/>

(3)プロセッサーメソッドに@ResponseBodyロゴを使用

(4) コントローラーメソッド内で直接 Java オブジェクトを返す

@RequestMapping("/testResponseUser")
@ResponseBody
public User testResponseUser(){
    return new User(1001,"admin","123456","男");
}
<a th:href="@{/testResponseUser}">测试@ResponseBody响应浏览器数据User对象</a><br>

実行結果:

4. RestControlle アノテーション
@RestController アノテーションは、springMVC が提供する複合アノテーションであり、コントローラー クラスにマークされます。これは、クラスに @Controller アノテーションを追加し、その中の各メソッドに @ResponseBody アノテーションを追加することと同じです
5.ResponseEntity
コントローラーメソッドの戻り値型には ResponseEntity を使用し、コントローラーメソッドの戻り値はブラウザへの応答メッセージ
 

 

 

おすすめ

転載: blog.csdn.net/weixin_46081857/article/details/122233330
おすすめ
Apache Doris バージョン 2.0.10 が正式にリリースされました。
Open Source Daily | 大手モデルが戦争に突入、大手モデルのユニコーンが身売りしていることが明らかに; 最大のオープンソース AI コミュニティが GPU の共有に 1,000 万ドルを提供すると示唆
ランキング
ジャンゴ使用KindEditorアップロード写真
FirstOrDefault VS C＃の検索
SQL UNIONルール
VS Code は HTML スタートアップを実装し、ホット アップデート サービスを提供します
Linux プログラミング: 1. コルーチンの設計原則
目标检测的“尽头”竟是语言建模？Hinton团队提出Pix2Seq：性能优于DETR
CTFdインストールの新バージョン以降の操作および保守について話します
構造体へのポインタ出力4人の学生学生ID名前性別年齢を使用することにより
1.3.2リリース、連続ファイル同期ツールをSyncthing
PyQt5 インストールチュートリアル
アーカイブ
もっと
2024-05-17(6)
2024-05-16(24)
2024-05-15(5)
2024-05-14(9)
2024-05-13(8)
2024-05-12(27)
2024-05-11(31)
2024-05-10(33)
2024-05-09(30)
2024-05-08(18)

コードワールド

© 2018 codetd.com