SpringCloud應用骨架開發(fā)詳解

更新時間：2020年09月17日 08:30:12 作者：最老程序員閆濤

這篇文章主要介紹了SpringCloud應用骨架開發(fā)詳解，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧

我們每做一個新項目，通常都是從另一個項目把代碼拷貝過來，然后在其上做開發(fā)。但是這種模式的一個比較大的問題就是會有很多上個項目的遺留代碼。因此，開發(fā)一個公共的應用骨架系統(tǒng)，在開始其他新項目時，從這個骨架系統(tǒng)開始開發(fā)，是一個很好的選擇。

我們首先需要創(chuàng)建一個SpringBoot工程，我們可以使用：https://start.spring.io/

如下所所：

在這里插入圖片描述

上圖中比較關鍵的是從頁面右側(cè)“Add Dependencies”按鈕彈出的列表中選擇“Spring Web”。網(wǎng)站上的工具會生成一個基本的SpringBoot工程，并自動將zip文件下載到本地。
將該文件解壓，以idea community版本打開（也可以使用商業(yè)版，但是該版本是收費版，出于尊重知識產(chǎn)權的原因，使用免費的社區(qū)版）。

我們首先將系統(tǒng)自帶的src/main/resources下面的application.properties文件刪除，添加application.yaml文件，添加如下內(nèi)容：

server:
 port: ${port:2208}
spring:
 application:
  name: first-service
logging:
 pattern:
  console: "%d{HH:mm:ss.SSS} %-5level %logger{36} - %msg%n"
  file: "%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n"
 level:
  org.springframework.web: DEBUG
 file: app.log

下面我們以Person對象的增、刪、改、查操作為例，創(chuàng)建一個REST風格的API。
我們首先在repository包中創(chuàng)建Person對象：

public class Person {
  private Long personId;
  private String firstName;
  private String lastName;
  private int age;
// getter and setters
//......
}

接下來我們來創(chuàng)建REST服務端，在controller包中創(chuàng)建DemoController類：

@RestController
@RequestMapping("/person")
public class DemoController {
  private List<Person> persons = new ArrayList<>();

  @GetMapping
  public List<Person> findAll() {
    return persons;
  }

  @GetMapping("/{personId}")
  public Person findById(@PathVariable("personId") Long personId,
              HttpServletRequest request) {
    String mode = request.getParameter("mode");
    System.out.println("mode=" + mode + "!");
    return persons.stream().filter(item -> item.getPersonId().equals(personId)).findFirst().get();
  }

  @PostMapping
  public Person add(@RequestBody Person p) {
    p.setPersonId((long)(persons.size()+1));
    persons.add(p);
    return p;
  }

  @DeleteMapping("/{personId}")
  public void delete(@PathVariable("personId") Long personId) {
    List<Person> ps = persons.stream().filter(item -> item.getPersonId().
        equals(personId)).collect(Collectors.toList());
    persons.removeAll(ps);
  }

  @PutMapping
  public void update(@RequestBody Person p) {
    Optional<Person> person = persons.stream().filter(item -> item.getPersonId().
        equals(p.getPersonId())).findFirst();
    person.ifPresent(po->persons.set(persons.indexOf(po), p));
  }
}

由于用到了Jdk8以后的一些特性，這里稍做一些解釋：

第1行：代表其是一個REST風格服務的類；
第2行：規(guī)定所有/person開頭的請求，都由本類來進行處理；
第4行：使用泛型技術定義Person列表對象屬性；
第6~9行：定義http://server/person請求，返回Json格式Person列表；
第11行：定義http://server/person/101?mode=2形式的請求，首先定義路徑中包含的參數(shù)101為personId，分別在GetMapping和函數(shù)參數(shù)中用@RequestParam來定義，其次請求中的queryString使用函數(shù)形參中的第二個參數(shù)HttpServletRequest來獲?。?/li>
第14、15行：獲取QueryString中的mode參數(shù)；
第16行：在過去，我們?nèi)缫雽ist對象進行查找，需要自己遍歷List對象，在Jdk8之后，提供了Stream API，可以幫助我們更加高效的進行查找。首先創(chuàng)建stream，這里其實還可以指定是否使用.parellel()并行技術來利用CPU的多核特性。然后在filter中定義查詢條件，該查詢條件是一個Lambda表達式，也是Jdk8之后引入的新特性，就是對列表中的每個元素item，首先獲取personId屬性，然后與personId參數(shù)進行比較，取相等的記錄，由于相等的記錄可能存在多條，我們用findFirst來取第一條，其返回結(jié)果為Optional類型，Optional同樣是Jdk8之后引入的新特性，專門用于避免空指針異常。我們這里，我們非常確信其一定包括Person對象，所以通過.get函數(shù)獲取出Person對象，并返回；
第19行：在REST風格中，POST請求用于添加新對象；
第20行：在缺省情況下，POST請求的內(nèi)容通過application/json傳遞，即客戶端需要將內(nèi)容轉(zhuǎn)換為Json格式，放入POST的請求體中，SpringBoot會自動將請求體的Json內(nèi)容轉(zhuǎn)化為@RequestBody指定的值對象；
第26行：在REST風格中，DELETE請求用于刪除對象，即當用戶發(fā)送的請求為DELETE /person/101 HTTP/1.0時，代表刪除personId=101的對象；
第27行：定義delete函數(shù)，獲取請求路徑上的personId參數(shù)；
第28、29行：求出符合查詢條件的Person對象列表，同樣是先用成stream，在filter中定義查詢條件，最后通過collect函數(shù)將查詢結(jié)果轉(zhuǎn)換為列表；
第30行：從persons列表中刪除符合條件記錄；
第33行：在REST風格中，用PUT請求來進行對象更新；
第34行：通過請求體中的Json字符串，由SpringBoot自動創(chuàng)建Person值對象；
第35、36行：查詢出符合條件的記錄，類型為Optional，在這里我們雖然可以使用if (ps.ifPresent()) {…}，但是這和過去null的處理方式?jīng)]有什么區(qū)別，我們采用更Jdk8的形式，在ifPresent函數(shù)中提供了Lambda表達式，這義了對象更新邏輯；

我們下面需要對REST服務進行測試，我們可以通過PostMan來進行測試，但是在這里，我們將采用Swagger來進行測試。這樣做主要好處是可以同時生成REST服務的文檔。
我們首先在項目根目錄下的pom.xml中添加如下內(nèi)容：

<!-- 開始：添加Swagger支持 -->
		<dependency>
			<groupId>io.springfox</groupId>
			<artifactId>springfox-swagger2</artifactId>
			<version>2.7.0</version>
		</dependency>
		<dependency>
			<groupId>io.springfox</groupId>
			<artifactId>springfox-swagger-ui</artifactId>
			<version>2.7.0</version>
		</dependency>
		<!-- 結(jié)束：添加Swagger支持 -->
		<!-- 開始：讀取maven pox.xml文件 -->
		<dependency>
			<groupId>org.apache.maven</groupId>
			<artifactId>maven-model</artifactId>
			<version>3.0</version>
		</dependency>
		<!-- 結(jié)束：讀取maven pox.xml文件 -->

同時給應用類StpApplication添加如下標注：

@EnableSwagger2
@SpringBootApplication
public class StpApplication {
	......

	@Bean
	public Docket api() throws IOException, XmlPullParserException {
		MavenXpp3Reader reader = new MavenXpp3Reader();
		Model model = reader.read(new FileReader("pom.xml"));
		ApiInfoBuilder builder = new ApiInfoBuilder()
				.title("智慧交通平臺")
				.description("智慧交通平臺API接口文檔")
				.version(model.getVersion())
				.contact(new Contact("最老程序員", "www.abc.com", "ua@"));
		return new Docket(DocumentationType.SWAGGER_2).select().
				apis(RequestHandlerSelectors.basePackage("com.zhuanjingkj.stp.demo.controller"))
						.paths(PathSelectors.any()).build()
						.apiInfo(builder.build());
	}
}

就是添加@EnableSwagger2標注信息。在瀏覽器中輸入如下地址：http://localhost:2208/swagger-ui.html

會顯示如下圖所示頁面：

在這里插入圖片描述