Spring Boot Starter的示例分析

這篇文章給大家分享的是有關(guān)Spring Boot Starter的示例分析的內(nèi)容。小編覺(jué)得挺實(shí)用的，因此分享給大家做個(gè)參考，一起跟隨小編過(guò)來(lái)看看吧。

Spring Boot 簡(jiǎn)介

Spring框架功能很強(qiáng)大，但是就算是一個(gè)很簡(jiǎn)單的項(xiàng)目，我們也要配置很多東西。因此就有了Spring Boot框架，它的作用很簡(jiǎn)單，就是幫我們自動(dòng)配置。Spring Boot框架的核心就是自動(dòng)配置，只要存在相應(yīng)的jar包，Spring就幫我們自動(dòng)配置。如果默認(rèn)配置不能滿足需求，我們還可以替換掉自動(dòng)配置類，使用我們自己的配置。另外，Spring Boot還集成了嵌入式的Web服務(wù)器，系統(tǒng)監(jiān)控等很多有用的功，讓我們快速構(gòu)建企業(yè)及應(yīng)用程序。

依賴管理是任何復(fù)雜項(xiàng)目的關(guān)鍵部分。以手動(dòng)的方式來(lái)實(shí)現(xiàn)依賴管理不太現(xiàn)實(shí)，你得花更多時(shí)間，同時(shí)你在項(xiàng)目的其他重要方面能付出的時(shí)間就會(huì)變得越少。

Spring Boot starter 就是為了解決這個(gè)問(wèn)題而誕生的。Starter POM 是一組方便的依賴描述符，您可以將其包含在應(yīng)用程序中。您可以獲得所需的所有 Spring 和相關(guān)技術(shù)的一站式服務(wù)，無(wú)需通過(guò)示例代碼搜索和復(fù)制粘貼依賴。

我們有超過(guò) 30 個(gè) Boot starter — 下文將提到其中一部分。

2、Web Starter

首先，讓我們來(lái)看看 REST 服務(wù)開(kāi)發(fā)。我們可以使用像 Spring MVC、Tomcat 和 Jackson 這樣的庫(kù)，這對(duì)于單個(gè)應(yīng)用程序來(lái)說(shuō)是還是存在許多依賴。

Spring Boot starter 通過(guò)添加一個(gè)依賴來(lái)幫助減少手動(dòng)添加依賴的數(shù)量。 因此，不要手動(dòng)指定依賴，您只需要添加一個(gè) starter 即可，如下所示：

<dependency>
 <groupId>org.springframework.boot</groupId>
 <artifactId>spring-boot-starter-web</artifactId>
</dependency>

現(xiàn)在我們可以創(chuàng)建一個(gè) REST 控制器。為了簡(jiǎn)單起見(jiàn)，我們不會(huì)使用數(shù)據(jù)庫(kù)，只專注于 REST 控制器：

@RestController
public class GenericEntityController{
 private List<GenericEntity> entityList = new ArrayList<>();
 @RequestMapping("/entity/all")
 public List<GenericEntity> findAll(){
  return entityList;
 }
 @RequestMapping(value = "/entity", method = RequestMethod.POST)
 public GenericEntity addEntity(GenericEntity entity){
  entityList.add(entity);
  return entity;
 }
 @RequestMapping("/entity/findby/{id}")
 public GenericEntity findById(@PathVariable Long id){
  return entityList.stream().
     filter(entity -> entity.getId().equals(id)).
     findFirst().get();
 }
}

GenericEntity是一個(gè)簡(jiǎn)單的 bean， id 的類型為 Long ， value 為 String 類型。

就是這樣，應(yīng)用程序可以開(kāi)始運(yùn)行了，您可以訪問(wèn) http://localhost:8080/springbootapp/entity/all 并檢查控制器是否正常工作。

我們已經(jīng)創(chuàng)建了一個(gè)配置非常少的 REST 應(yīng)用程序。

3、Test Starter

對(duì)于測(cè)試，我們通常使用以下組合：Spring Test、JUnit、Hamcrest 和 Mockito。我們可以手動(dòng)包含所有這些庫(kù)，但使用以下 Spring Boot starter 方式可以自動(dòng)包含這些庫(kù)：

<dependency>
 <groupId>org.springframework.boot</groupId>
 <artifactId>spring-boot-starter-test</artifactId>
 <scope>test</scope>
</dependency>

請(qǐng)注意，您不需要指定工件的版本號(hào)。Spring Boot 會(huì)自動(dòng)選擇合適的版本 — 您僅需要指定 spring-boot-starter-parent-artifact 的版本。 如果之后您想要升級(jí) Boot 庫(kù)和依賴，只需在一個(gè)地方升級(jí) Boot 版本即可，它將會(huì)處理其余部分。

讓我們來(lái)測(cè)試一下之前創(chuàng)建的控制器。

測(cè)試控制器有兩種方法：

• 使用 mock 環(huán)境

• 使用嵌入式 Servlet 容器（如 Tomcat 或 Jetty）
  

在本例中，我們將使用一個(gè) mock 環(huán)境：

@RunWith(SpringJUnit4ClassRunner.class)
@SpringApplicationConfiguration(classes = Application.class)
@WebAppConfiguration
public class SpringBootApplicationTest{
 @Autowired
 private WebApplicationContext webApplicationContext;
 private MockMvc mockMvc;
 @Before
 public void setupMockMvc(){
  mockMvc = MockMvcBuilders.webAppContextSetup(webApplicationContext).build();
 }
 @Test
 public void givenRequestHasBeenMade_whenMeetsAllOfGivenConditions_thenCorrect()
  throws Exception { 
  MediaType contentType = new MediaType(MediaType.APPLICATION_JSON.getType(),
  MediaType.APPLICATION_JSON.getSubtype(), Charset.forName("utf8"));
  mockMvc.perform(MockMvcRequestBuilders.get("/entity/all")).
  andExpect(MockMvcResultMatchers.status().isOk()).
  andExpect(MockMvcResultMatchers.content().contentType(contentType)).
  andExpect(jsonPath("$", hasSize(4))); 
 } 
}

這里重要的是 @WebAppConfiguration 注解和 MockMVC 是 spring-test 模塊的一部分， hasSize 是一個(gè) Hamcrest matcher， @Before 是一個(gè) JUnit 注解。這些都可以通過(guò)導(dǎo)入這一個(gè)這樣的 starter 依賴來(lái)引入。

4、Data JPA Starter

大多數(shù) Web 應(yīng)用程序都存在某些持久化 — 常見(jiàn)的是 JPA。

讓我們使用 starter 來(lái)開(kāi)始，而不是手動(dòng)定義所有關(guān)聯(lián)的依賴：

<dependency>
 <groupId>org.springframework.boot</groupId>
 <artifactId>spring-boot-starter-data-jpa</artifactId>
</dependency>
<dependency>
 <groupId>com.h3database</groupId>
 <artifactId>h3</artifactId>
 <scope>runtime</scope>
</dependency>

請(qǐng)注意，我們對(duì)這些數(shù)據(jù)庫(kù)已經(jīng)有了開(kāi)箱即用的自動(dòng)支持：H2、Derby 和 Hsqldb。在我們的示例中，我們將使用 H2。

現(xiàn)在讓我們?yōu)閷?shí)體創(chuàng)建倉(cāng)儲(chǔ)（repository）：

public interface GenericEntityRepositoryextends JpaRepository<GenericEntity,Long>{}

現(xiàn)在是測(cè)試代碼的時(shí)候了。這是 JUnit 測(cè)試：

@RunWith(SpringJUnit4ClassRunner.class)
@SpringApplicationConfiguration(classes = Application.class)
public class SpringBootJPATest{
 @Autowired
 private GenericEntityRepository genericEntityRepository;
 
 @Test
 public void givenGenericEntityRepository_whenSaveAndRetreiveEntity_thenOK(){
  GenericEntity genericEntity = 
   genericEntityRepository.save(new GenericEntity("test"));
  GenericEntity foundedEntity = 
   genericEntityRepository.findOne(genericEntity.getId());
   
  assertNotNull(foundedEntity);
  assertEquals(genericEntity.getValue(), foundedEntity.getValue());
 }
}

我們沒(méi)有花時(shí)間指定數(shù)據(jù)庫(kù)廠商、URL 連接和憑據(jù)。沒(méi)有額外所需的配置，這些都受益于 Boot 的默認(rèn)支持。 但是，如果您需要，可以進(jìn)行詳細(xì)配置。

5、Mail Starter

企業(yè)開(kāi)發(fā)中一個(gè)非常常見(jiàn)的任務(wù)就是發(fā)送電子郵件，直接使用 Java Mail API 來(lái)處理通常很困難。

Spring Boot starter 屏蔽了這些復(fù)雜性 — mail 依賴可以通過(guò)以下方式指定：

<dependency>
 <groupId>org.springframework.boot</groupId>
 <artifactId>spring-boot-starter-mail</artifactId>
</dependency>

現(xiàn)在我們可以直接使用 JavaMailSender 。讓我們開(kāi)始編寫(xiě)一些測(cè)試。

為了測(cè)試，我們需要一個(gè)簡(jiǎn)單的 SMTP 服務(wù)器。在此例中，我們將使用 Wiser。將其包含到我們的 POM 中：

<dependency>
 <groupId>org.subethamail</groupId>
 <artifactId>subethasmtp</artifactId>
 <version>3.1.7</version>
 <scope>test</scope>
</dependency>

最新版本的 Wiser 可以在 Maven 中央倉(cāng)庫(kù) （ http://search.maven.org/#search%7Cga%7C1%7Csubethasmtp）中找到。

以下是測(cè)試源碼：

@RunWith(SpringJUnit4ClassRunner.class)
@SpringApplicationConfiguration(classes = Application.class)
public class SpringBootMailTest{
 @Autowired
 private JavaMailSender javaMailSender;
 private Wiser wiser;
 private String userTo = "user2@localhost";
 private String userFrom = "user1@localhost";
 private String subject = "Test subject";
 private String textMail = "Text subject mail";
 @Before
 public void setUp()throws Exception {
  final int TEST_PORT = 25;
  wiser = new Wiser(TEST_PORT);
  wiser.start();
 }
 @After
 public void tearDown()throws Exception {
  wiser.stop();
 }
 @Test
 public void givenMail_whenSendAndReceived_thenCorrect()throws Exception {
  SimpleMailMessage message = composeEmailMessage();
  javaMailSender.send(message);
  List<WiserMessage> messages = wiser.getMessages();
  assertThat(messages, hasSize(1));
  WiserMessage wiserMessage = messages.get(0);
  assertEquals(userFrom, wiserMessage.getEnvelopeSender());
  assertEquals(userTo, wiserMessage.getEnvelopeReceiver());
  assertEquals(subject, getSubject(wiserMessage));
  assertEquals(textMail, getMessage(wiserMessage));
 }
 private String getMessage(WiserMessage wiserMessage)
  throws MessagingException, IOException {
  return wiserMessage.getMimeMessage().getContent().toString().trim();
 }
 private String getSubject(WiserMessage wiserMessage)throws MessagingException {
  return wiserMessage.getMimeMessage().getSubject();
 }
 private SimpleMailMessage composeEmailMessage(){
  SimpleMailMessage mailMessage = new SimpleMailMessage();
  mailMessage.setTo(userTo);
  mailMessage.setReplyTo(userFrom);
  mailMessage.setFrom(userFrom);
  mailMessage.setSubject(subject);
  mailMessage.setText(textMail);
  return mailMessage;
 }
}

在測(cè)試中， @Before 和 @After 方法負(fù)責(zé)啟動(dòng)和停止郵件服務(wù)器。

請(qǐng)注意，我們裝配了 JavaMailSender bean — 該 bean 是 由 Spring Boot 自動(dòng)創(chuàng)建 。

與 Boot 中的其他默認(rèn)值一樣， JavaMailSender 的 email 設(shè)置可以在 application.properties 中自定義：

spring.mail.host=localhost
spring.mail.port=25
spring.mail.properties.mail.smtp.auth=false

我們?cè)?localhost:25 上配置了郵件服務(wù)器，不需要身份驗(yàn)證。

6、結(jié)論

在本文中，我們介紹了 Starter，解釋了為什么我們需要它們，并提供了如何在項(xiàng)目中使用它們的示例。

讓我們回顧一下使用 Spring Boot starter 的好處：

• 增加 pom 可管理性

• 生產(chǎn)就緒、測(cè)試與依賴配置支持

• 減少項(xiàng)目的整體配置時(shí)間

感謝各位的閱讀！關(guān)于“Spring Boot Starter的示例分析”這篇文章就分享到這里了，希望以上內(nèi)容可以對(duì)大家有一定的幫助，讓大家可以學(xué)到更多知識(shí)，如果覺(jué)得文章不錯(cuò)，可以把它分享出去讓更多的人看到吧！