Spring Boot使用RESTful Web服務

本章將詳細討論和學習如何使用jQuery AJAX來呼叫RESTful Web服務。

建立一個簡單的Spring Boot Web應用程式並編寫一個控制器類檔案，用於重定向到HTML檔案以使用RESTful Web服務。需要在構建組態檔案中新增Spring Boot啟動程式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 檔案中 -

compile group: 'org.springframework.boot', name: 'spring-boot-starter-thymeleaf'
compile('org.springframework.boot:spring-boot-starter-web')

@Controller類檔案的程式碼如下 -

@Controller
public class ViewController {
}

定義請求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

現在，在類路徑的templates 目錄下建立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 
   http://maven.apache.org/xsd/maven-4.0.0.xsd」>

   <modelVersion>4.0.0</modelVersion>
   <groupId>com.yiibai</groupId>
   <artifactId>demo</artifactId>
   <version>0.0.1-SNAPSHOT</version>
   <packaging>jar</packaging>
   <name>demo</name>
   <description>Demo project for Spring Boot</description>

   <parent>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-parent</artifactId>
      <version>1.5.8.RELEASE</version>
      <relativePath />
   </parent>

   <properties>
      <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
      <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
      <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>
      </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>

</project>

Gradle構建檔案 - build.gradle 的程式碼如下 -

buildscript {
   ext {
      springBootVersion = '1.5.8.RELEASE'
   }
   repositories {
      mavenCentral()
   }
   dependencies {
      classpath("org.springframework.boot:spring-boot-gradle-plugin:${springBootVersion}")
   }
}

apply plugin: 'java'
apply plugin: 'eclipse'
apply plugin: 'org.springframework.boot'

group = 'com.yiibai'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = 1.8

repositories {
   mavenCentral()
}

dependencies {
   compile('org.springframework.boot:spring-boot-starter-web')
   compile group: 'org.springframework.boot’, name: ‘spring-boot-starter-thymeleaf'
   testCompile('org.springframework.boot:spring-boot-starter-test')
}

下面給出的控制器類檔案 - ViewController.java 如下 -

package com.yiibai.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應用程式類檔案如下 -

package com.yiibai.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」之後，可以在目標目錄下找到JAR檔案。

對於Gradle，請使用下面給出的命令 -

gradle clean build

在「BUILD SUCCESSFUL」之後，在build/libs目錄下找到JAR檔案。
使用以下命令執行JAR檔案 -

java –jar <JARFILE>

現在，應用程式已在Tomcat埠8080上啟動。

在Web瀏覽器中存取URL => http://localhost:8080/view-products ，可以看到如下所示的輸出 -

存取URL => http://localhost:8080/add-products ，可以看到如下所示的輸出 -

現在，單擊按鈕提交表單，可以看到顯示的結果 -

現在，點選檢視產品URL => http://localhost:8080/view-products ，檢視建立的產品。

使用 Angular JS

要使用Angular JS來使用API，可以使用下面給出的範例 -

使用以下程式碼建立Angular JS Controller以使用GET API => http://localhost:9090/products

angular.module('demo', [])
.controller('Hello', function($scope, $http) {
   $http.get('http://localhost:9090/products').
   then(function(response) {
      $scope.products = response.data;
   });
});

使用以下程式碼建立Angular JS Controller以使用POST API => http://localhost:9090/products

angular.module('demo', [])
.controller('Hello', function($scope, $http) {
   $http.post('http://localhost:9090/products',data).
   then(function(response) {
      console.log("Product created successfully");
   });
});

註 - Post方法資料以JSON格式表示建立產品的請求正文。