SpringBoot使用Spring Data REST快速建構restful應用

本篇要點

Spring Data REST的基本介紹。
SpringBoot快速建構restful風格接口。

Spring Data REST概述

REST Web服務已經成為Web上應用程式內建的第一大手段。 REST的核心是定義一個包含與用戶端進行互動資源的系統。這些資源以超媒體驅動的方式實作。

Spring MVC和Spring WebFlux各自提供了建構REST服務的堅實基礎。但是，即使為multi-domain對象系統實作最簡單的REST Web服務原則也可能很繁瑣，并且會導緻大量樣闆代碼。

Spring Data REST旨在解決這個問題，它建立在Spring Data存儲庫之上，并自動将其導出為REST資源，用戶端可以輕松查詢并調用存儲庫本身暴露出來的接口。

SpringBoot快速建構restful風格接口

SpringBoot建構Spring Data REST是相當友善的，因為自動化配置的存在，spring-boot-starter-data-rest可以讓你不需要寫多少代碼，就能輕松建構一套完整的rest應用。

除此之外，你需要引入資料存儲的依賴，它支援SpringData JPA、Spring Data MongoDB等，這裡就使用JPA啦。

建立項目，導入依賴

<!--jpa-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-jpa</artifactId>
        </dependency>
        <!--restful-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-rest</artifactId>
        </dependency>
        <!--web-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <!--mysql-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <scope>runtime</scope>
        </dependency>
        <!--lombok-->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>

yml配置

server:
  port: 8081
spring:
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://localhost:3306/restful?serverTimezone=GMT%2B8
    username: root
    password: 123456
    hikari:
      maximum-pool-size: 20
      minimum-idle: 5
  jpa:
    database: mysql
    #在建表的時候，将預設的存儲引擎切換為 InnoDB
    database-platform: org.hibernate.dialect.MySQL5InnoDBDialect
    # 配置在日志中列印出執行的 SQL 語句資訊。
    show-sql: true
    # 配置指明在程式啟動的時候要删除并且建立實體類對應的表。
    hibernate:
      ddl-auto: update

定義實體類

@Entity(name = "t_user")
@Data
@AllArgsConstructor
@NoArgsConstructor
public class User implements Serializable {

    private static final long serialVersionUID = 1L;

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;

    private String username;
    private String password;

    @Column(length = 20)
    private Integer age;
}

定義Repository接口

public interface UserDao extends JpaRepository<User, Long> {
}

到這裡為止，其實可以發現，和JPA文章沒啥差異，除了多引入了一個rest依賴。ok，啟動項目，先把表生成了再說。

啟動項目，我們就會發現JPA已經為我們将表結建構立完成，并且，一個基于Restful風格的增删改查應用也已誕生，我們可以使用接口測試工具，進行測試。

測試Restful接口

預設的請求路徑是類名首字母小寫+字尾s，這裡就是users。

測試添加功能

POST: http://localhost:8081/users
{
    "username": "summerday",
    "password": "123456",
    "age": 18
}

添加成功之後，傳回資訊如下：

{
  "username": "summerday",
  "password": "123456",
  "age": 18,
  "_links": {
    "self": {
      "href": "http://localhost:8081/users/1"
    },
    "user": {
      "href": "http://localhost:8081/users/1"
    }
  }
}

測試删除功能

DELETE : http://localhost:8081/users/1
// 删除成功之後傳回删除的 id = 1

測試修改功能

PUT : http://localhost:8081/users/2
{
    "username": "summerday111",
    "password": "123456111",
    "age": 181
}

同樣的，修改成功，将對應id為2的資訊改為傳入資訊，并傳回更新後的資訊。

{
  "username": "summerday111",
  "password": "123456111",
  "age": 181,
  "_links": {
    "self": {
      "href": "http://localhost:8081/users/2"
    },
    "user": {
      "href": "http://localhost:8081/users/2"
    }
  }
}

測試根據id查詢

GET : http://localhost:8081/users/3

測試分頁查詢

GET : http://localhost:8081/users

分頁查詢結果：

{
  "_embedded": {
    "users": [
      {
        "username": "summerday111",
        "password": "123456111",
        "age": 181,
        "_links": {
          "self": {
            "href": "http://localhost:8081/users/2"
          },
          "user": {
            "href": "http://localhost:8081/users/2"
          }
        }
      },
      {
        "username": "summerday",
        "password": "123456",
        "age": 18,
        "_links": {
          "self": {
            "href": "http://localhost:8081/users/3"
          },
          "user": {
            "href": "http://localhost:8081/users/3"
          }
        }
      }
    ]
  },
  "_links": {
    "self": {
      "href": "http://localhost:8081/users"
    },
    "profile": {
      "href": "http://localhost:8081/profile/users"
    }
  },
  "page": {
    "size": 20,
    "totalElements": 2,
    "totalPages": 1,
    "number": 0
  }
}

測試分頁+排序

GET : http://localhost:8081/users?page=0&size=1&sort=age,desc

第一頁，每頁size為1的記錄，按age逆序。

{
  "_embedded": {
    "users": [
      {
        "username": "summerday111",
        "password": "123456111",
        "age": 181,
        "_links": {
          "self": {
            "href": "http://localhost:8081/users/2"
          },
          "user": {
            "href": "http://localhost:8081/users/2"
          }
        }
      }
    ]
  },
  "_links": {
    "first": {
      "href": "http://localhost:8081/users?page=0&size=1&sort=age,desc"
    },
    "self": {
      "href": "http://localhost:8081/users?page=0&size=1&sort=age,desc"
    },
    "next": {
      "href": "http://localhost:8081/users?page=1&size=1&sort=age,desc"
    },
    "last": {
      "href": "http://localhost:8081/users?page=1&size=1&sort=age,desc"
    },
    "profile": {
      "href": "http://localhost:8081/profile/users"
    }
  },
  "page": {
    "size": 1,
    "totalElements": 2,
    "totalPages": 2,
    "number": 0
  }
}

定制查詢

自定義查詢接口

public interface UserDao extends JpaRepository<User, Long> {

    List<User> findUsersByUsernameContaining(@Param("username")String username);
}

通路：http://localhost:8081/users/search，查詢自定義接口。

{
  "_links": {
    "findUsersByUsernameContaining": {
      "href": "http://localhost:8081/users/search/findUsersByUsernameContaining{?username}",
      "templated": true
    },
    "self": {
      "href": "http://localhost:8081/users/search"
    }
  }
}

測試一下這個方法：

GET : http://localhost:8081/users/search/findUsersByUsernameContaining?username=111

{
  "_embedded": {
    "users": [
      {
        "username": "summerday111",
        "password": "123456111",
        "age": 181,
        "_links": {
          "self": {
            "href": "http://localhost:8081/users/2"
          },
          "user": {
            "href": "http://localhost:8081/users/2"
          }
        }
      }
    ]
  },
  "_links": {
    "self": {
      "href": "http://localhost:8081/users/search/findUsersByUsernameContaining?username=111"
    }
  }
}

自定義接口名

public interface UserDao extends JpaRepository<User, Long> {
    //rel 表示接口查詢中，這個方法的 key 
    //path 表示請求路徑
    @RestResource(rel = "auth", path = "auth")
    User findByUsernameAndPassword(@Param("name") String username, @Param("pswd") String password);
}

繼續查詢自定義的接口：

"auth": {
      "href": "http://localhost:8081/users/search/auth{?name,pswd}",
      "templated": true
    }

測試一下：

GET : http://localhost:8081/users/search/auth?name=summerday&pswd=123456

設定接口對前端隐藏

@Override
    @RestResource(exported = false)
    void deleteById(Long aLong);

定義生成JSON字元串的相關資訊

@RepositoryRestResource(collectionResourceRel = "userList",itemResourceRel = "u",path = "user")
public interface UserDao extends JpaRepository<User, Long> {
}

此時路徑名為/user：

GET : http://localhost:8081/user/2

{
  "username": "summerday111",
  "password": "123456111",
  "age": 181,
  "_links": {
    "self": {
      "href": "http://localhost:8081/user/2"
    },
    "u": {
      "href": "http://localhost:8081/user/2"
    }
  }
}

其他配置屬性

Spring Data REST其他可配置的屬性，通過spring.data.rest.basePath=/v1的形式指定。

屬性	描述
basePath	the root URI
defaultPageSize	每頁預設size
maxPageSize
pageParamName	配置分頁查詢時頁碼的 key，預設是 page
limitParamName	配置分頁查詢時每頁查詢頁數的 key，預設是size
sortParamName	配置排序參數的 key ，預設是 sort
defaultMediaType	配置預設的媒體類型
returnBodyOnCreate	添加成功時是否傳回添加記錄
returnBodyOnUpdate	更新成功時是否傳回更新記錄

為幫助開發者們提升面試技能、有機會入職BATJ等大廠公司，特别制作了這個專輯——這一次整體放出。

大緻内容包括了： Java 集合、JVM、多線程、并發程式設計、設計模式、Spring全家桶、Java、MyBatis、ZooKeeper、Dubbo、Elasticsearch、Memcached、MongoDB、Redis、MySQL、RabbitMQ、Kafka、Linux、Netty、Tomcat等大廠面試題等、等技術棧！

歡迎大家關注公衆号【Java爛豬皮】，回複【666】，擷取以上最新Java後端架構VIP學習資料以及視訊學習教程，然後一起學習，一文在手，面試我有。

每一個專欄都是大家非常關心，和非常有價值的話題，如果我的文章對你有所幫助，還請幫忙點贊、好評、轉發一下，你的支援會激勵我輸出更高品質的文章，非常感謝！

SpringBoot使用Spring Data REST快速建構restful應用

本篇要點

Spring Data REST概述

SpringBoot快速建構restful風格接口

建立項目，導入依賴

yml配置

定義實體類

定義Repository接口

測試Restful接口

測試添加功能

測試删除功能

測試修改功能

測試根據id查詢

測試分頁查詢

測試分頁+排序

定制查詢

自定義查詢接口

自定義接口名

設定接口對前端隐藏

定義生成JSON字元串的相關資訊

其他配置屬性

繼續閱讀

馴服爛代碼_馴服Tomcat：Tomcat 5的過濾技巧

基于Springboot+VUE+Mysql的大學生校園疫情防控管理系統

Using MessageConverter

馴服爛代碼_C＃中的馴服配置

springboot使用 swagger-ui 2.10.5 有關版本更新帶來的問題

Spring Cloud整合Sleuth，當請求完成後，Zipkin沒有鍊路資訊

JAVA自學之路——馬士兵

Rabbitmq指令行手動建立隊列

整合 Spring 開發架構及服務端技術

SSM整合02---Spring-SpringMVC層一、添加web架構支援二、web.xml三、spring-mvc.xml

SSM架構（二）------------表現層的SpringMVC

Intellij idea基于Maven 的SSM 架構整合

Spring資料和Redis

SpringMVC的啟動過程源碼分析1 SpringMVC 配置XML的方式啟動2 SpringMVC純注解模式啟動

Java Spring 架構

SpringCloud微服務（四）之ribbon筆記ribbon是什麼？入門案例自定義均衡負載算法