Spring Boot 消费 RESTful Web服务



  • 消费 RESTful Web服务

    本章将详细讨论有关使用jQuery AJAX使用RESTful Web服务的信息。创建一个简单的Spring Boot Web应用程序并编写一个控制器类文件,该文件用于重定向到HTML文件以使用RESTful Web服务。 我们需要在构建配置文件中添加Spring Boot Starter Thymeleaf和Web依赖项。
    对于Maven用户,在pom.xml文件中添加以下依赖项。
    
    <dependency>
       <groupId>org.springframework.boot</groupId>
       <artifactId>spring-boot-starter-thymeleaf</artifactId>
    </dependency>
    
    <dependency>
       <groupId>org.springframework.boot</groupId>
       <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    
    
    对于Gradle用户,将以下依赖项添加到build.gradle文件中-
    
    implementation 'org.springframework.boot:spring-boot-starter-thymeleaf'
    implementation 'org.springframework.boot:spring-boot-starter-web'
    
    
    @Controller类文件的代码在下面给出-
    
    @Controller
    public class ViewController {
    }
    
    
    您可以定义Request URI方法以重定向到HTML文件,如下所示-
    
    @RequestMapping(“/view-products”)
    public String viewProducts() {
       return “view-products”;
    }
    @RequestMapping(“/add-products”)
    public String addProducts() {
       return “add-products”;
    }
    
    
    这个API - http://localhost:9090/products应该返回以下JSON作为响应,如下所示-
    
    [
       {
          "id": "1",
          "name": "Honey"
       },
       {
          "id": "2",
          "name": "Almond"
       }
    ]
    
    
    现在,在类路径的templates目录下创建一个view-products.html文件。在HTML文件中,我们添加了jQuery库并编写了代码以在页面加载时使用RESTful Web服务。
    
    <script src = "https://ajax.googleapis.com/ajax/libs/jquery/3.2.1/jquery.min.js"></script>
    
    <script>
    $(document).ready(function(){
       $.getJSON("http://localhost:9090/products", function(result){
          $.each(result, function(key,value) {
             $("#productsJson").append(value.id+" "+value.name+" ");
          }); 
       });
    });
    </script>
    
    
    POST方法访问此URL - http://localhost:9090/products应该包含下面的请求正文和响应正文。 请求主体的代码如下-
    
    {
       "id":"3",
       "name":"Ginger"
    }
    
    
    响应主体的代码如下-
    
    Product is created successfully
    
    
    现在,在类路径的模板目录下创建add-products.html文件。 在HTML文件中,我们添加了jQuery库,并编写了单击该按钮将表单提交到RESTful Web服务的代码。
    
    <script src = "https://ajax.googleapis.com/ajax/libs/jquery/3.2.1/jquery.min.js"></script>
    <script>
       $(document).ready(function() {
          $("button").click(function() {
             var productmodel = {
                id : "3",
                name : "Ginger"
             };
             var requestJSON = JSON.stringify(productmodel);
             $.ajax({
                type : "POST",
                url : "http://localhost:9090/products",
                headers : {
                   "Content-Type" : "application/json"
                },
                data : requestJSON,
                success : function(data) {
                   alert(data);
                },
                error : function(data) {
                }
             });
          });
       });
    </script>
    
    
  • 完整代码

    Maven – pom.xml文件
    
    <?xml version="1.0" encoding="UTF-8"?>
    <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
        <modelVersion>4.0.0</modelVersion>
        <parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>2.3.0.BUILD-SNAPSHOT</version>
            <relativePath/> <!-- lookup parent from repository -->
        </parent>
        <groupId>com.jc2182</groupId>
        <artifactId>demo</artifactId>
        <version>0.0.1-SNAPSHOT</version>
        <name>demo</name>
        <description>Demo project for Spring Boot</description>
    
        <properties>
            <java.version>1.8</java.version>
        </properties>
    
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency> 
    
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-test</artifactId>
                <scope>test</scope>
                <exclusions>
                    <exclusion>
                        <groupId>org.junit.vintage</groupId>
                        <artifactId>junit-vintage-engine</artifactId>
                    </exclusion>
                </exclusions>
            </dependency>
    
            <dependency>
               <groupId>org.springframework.boot</groupId>
               <artifactId>spring-boot-starter-thymeleaf</artifactId>
            </dependency>
    
        </dependencies>
    
        <build>
            <plugins>
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                </plugin>
            </plugins>
        </build>
    
        <repositories>
            <repository>
                <id>spring-milestones</id>
                <name>Spring Milestones</name>
                <url>https://repo.spring.io/milestone</url>
            </repository>
            <repository>
                <id>spring-snapshots</id>
                <name>Spring Snapshots</name>
                <url>https://repo.spring.io/snapshot</url>
                <snapshots>
                    <enabled>true</enabled>
                </snapshots>
            </repository>
        </repositories>
        <pluginRepositories>
            <pluginRepository>
                <id>spring-milestones</id>
                <name>Spring Milestones</name>
                <url>https://repo.spring.io/milestone</url>
            </pluginRepository>
            <pluginRepository>
                <id>spring-snapshots</id>
                <name>Spring Snapshots</name>
                <url>https://repo.spring.io/snapshot</url>
                <snapshots>
                    <enabled>true</enabled>
                </snapshots>
            </pluginRepository>
        </pluginRepositories>
    
    </project>
    
    
    下面给出了Gradle – build.gradle的代码-
    
    
    plugins {
        id 'org.springframework.boot' version '2.3.0.BUILD-SNAPSHOT'
        id 'io.spring.dependency-management' version '1.0.9.RELEASE'
        id 'java'
    }
    
    group = 'com.jc2182'
    version = '0.0.1-SNAPSHOT'
    sourceCompatibility = '1.8'
    
    repositories {
        mavenCentral()
        maven { url 'https://repo.spring.io/milestone' }
        maven { url 'https://repo.spring.io/snapshot' }
    }
    
    dependencies {
        implementation 'org.springframework.boot:spring-boot-starter-web'
        implementation 'org.springframework.boot:spring-boot-starter-thymeleaf'
        testImplementation('org.springframework.boot:spring-boot-starter-test') {
            exclude group: 'org.junit.vintage', module: 'junit-vintage-engine'
        }
    }
    
    test {
        useJUnitPlatform()
    }    
    
    
    下面给出的控制器类文件– ViewController.java在下面给出-
    
    package com.jc2182.demo.controller;
    
    import org.springframework.stereotype.Controller;
    import org.springframework.web.bind.annotation.RequestMapping;
    
    @Controller
    public class ViewController {
       @RequestMapping(“/view-products”)
       public String viewProducts() {
          return “view-products”;
       }
       @RequestMapping(“/add-products”)
       public String addProducts() {
          return “add-products”;   
       }   
    }
    
    
    下面给出了view-products.html文件-
    
    <!DOCTYPE html>
    <html>
       <head>
          <meta charset = "ISO-8859-1"/>
          <title>View Products</title>
          <script src = "https://ajax.googleapis.com/ajax/libs/jquery/3.2.1/jquery.min.js"></script>
          
          <script>
             $(document).ready(function(){
                $.getJSON("http://localhost:9090/products", function(result){
                   $.each(result, function(key,value) {
                      $("#productsJson").append(value.id+" "+value.name+" ");
                   }); 
                });
             });
          </script>
       </head>
       
       <body>
          <div id = "productsJson"> </div>
       </body>
    </html>
    
    
    add-products.html文件在下面给出-
    
    <!DOCTYPE html>
    <html>
       <head>
          <meta charset = "ISO-8859-1" />
          <title>Add Products</title>
          <script src = "https://ajax.googleapis.com/ajax/libs/jquery/3.2.1/jquery.min.js"></script>
          
          <script>
             $(document).ready(function() {
                $("button").click(function() {
                   var productmodel = {
                      id : "3",
                      name : "Ginger"
                   };
                   var requestJSON = JSON.stringify(productmodel);
                   $.ajax({
                      type : "POST",
                      url : "http://localhost:9090/products",
                      headers : {
                         "Content-Type" : "application/json"
                      },
                      data : requestJSON,
                      success : function(data) {
                         alert(data);
                      },
                      error : function(data) {
                      }
                   });
                });
             });
          </script>
       </head>
       
       <body>
          <button>Click here to submit the form</button>
       </body>
    </html>
    
    
    下面给出了的Spring Boot Application类入口文件文件-
    
    package com.jc2182.demo;
    
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    
    @SpringBootApplication
    public class DemoApplication {
       public static void main(String[] args) {
          SpringApplication.run(DemoApplication.class, args);
       }
    }
    
    
    现在,您可以创建一个可执行的JAR文件,并使用以下Maven或Gradle命令运行Spring Boot应用程序。
    对于Maven,您可以使用以下命令-
    
    mvn clean install
    
    
    在“BUILD SUCCESS”之后,您可以在target目录下找到JAR文件。
    对于Gradle,您可以使用以下命令-
    
    gradle clean build
    
    
    在“BUILD SUCCESSFUL”之后,您可以在build/libs目录下找到JAR文件。
    您可以使用以下命令运行JAR文件-
    
    java –jar <JARFILE>
    
    
    在Tomcat端口8080上启动应用程序
    现在在您的Web浏览器中访问URL - http://localhost:8080/view-products,您可以看到如下所示的输出-
    crestful
    http://localhost:8080/add-products
    crestful
    现在,单击按钮以提交表单,您可以看到如下所示的结果-
    crestful
    现在,点击查看产品URL - http://localhost:8080/view-products 并查看创建的产品。
    crestful
    提示:修改Tomcat监听的端口在application.properties文件中server.port = 9090。RESTFul Web服务搭建教程请查看>>>>>
    注意:本示例监听在8080端口,去请求9090端口的服务被视为跨域操作,有关跨域的教程详情查看后面章节