【PDF】【Java微服务实战.pdf】
开发第一个Spring Boot 程序
开发环境(仅参考):
• JDK 版本: 1.8.0_ 73 (Spring Boot 官方推荐使用1.8 及以上) 。
• Spring Boot 版本:1.4.3.RELEASE 及以上。
• Maven 版本:3.3.9 及以上。
• 开发工具:IntellJ IDEA15 及以上。
在IDEA 中创建了一个Maven 项目,项目名为firstboot ,项目的代码结构如下:
整个项目的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.microservice</groupId>
<artifactId>firstboot</artifactId>
<version>1.0-SNAPSHOT</version>
<properties>
<java.version>1.8</java.version>
</properties>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>1.4.3.RELEASE</version>
</parent>
<dependencies>
<dependency>
<groupid>org.springframework.boot</groupid>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
- 在标签下通过<java.version>l .8</ava.version>指定了所使用的JDK 版本为1.8 ,这是官方推荐的方式。
- 使用spring-boot-starter-parent作为项目parent,并且指定了Spring Boot 的版本为1.4.3.RELEASE(依据最新版本更改),这样firstboot 项目就成为了一个标准的Spring Boot 项目,这也是官方推荐的Spring Boot 的使用方式。
- 引人spring-boot-starter-web 的依赖之后,整个项目会自动引人tomcat 和spring-webmvc 等相关包,以支持全栈的Web 开发。我们不需要指定该依赖的版本,因为已经在spring-boot-starter-parent 中对version 进行了指定。
- 最后,引人了spring-boot-maven-plugin 插件,强烈推荐在一个Spring Boot 项目中引人该插件,该插件会对Maven 生成的jar 包进行二次打包,打成一个fat-jar 包之后,我们就可以直接使用“java -jar xxx.jar ”来运行服务了,非常方便。
在创建好pom.xml 文件之后,又创建了一个com.microservice.firstboot 包,在该包下创建一个Application.java 类。该类的代码如下:
package com.microservice.firstboot;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
pubilc class Application {
public static void main(String[] args) {
SpringApplication.run(FirstbootApplication.class, args);
}
}
Application.java 是一个非常重要的类,通常被称为主类或启动类,是整个Spring Boot项目的启动入口。包含一个main 方法,而且整个应用中只能有一个main 方法,否则,启动会报错。在主类上需要添加注解@ SpringBootApplication ,该注解是一个复合注解,其包含的比较重要的注解是以下三个。
@Spring BootConfiguration: 该注解也是一个复合注解,其中最重要的注解是@Configuration,指明该类由Spring 容器管理。
@EnableAutoConfiguration:该注解用于启动服务的自动配置功能。
@ComponentScan:该注解用于扫描类,其作用类似于Spring 中自<context:component-scan>标签。
细心的会发现一个有趣的事情:
firstboot 项目的项目名与artifactld相同,并且在firstboot 项目下有一个路径最短的包com.microservice.fustboot ,该包名正好是.,并且主类就位于该最短路径包下! 注意,这不是偶然的,这是企业使用Spring Boot 构建项目的最标准的做法。使用.作为最短路径包名,不仅语义明确,而且也方便我们写maven-archetype,而将主类放在最短路径包下,主要是为了方便@ComponentScan扫描整个项目中的类。
定义一个简单的controller ,代码如下:
package com.microservice.firstboot.controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;
@RestController
@RequestMapping("/firstboot")
public class FirstBootController {
@RequestMapping(value = "/sayHello", method = RequestMethod.GET)
public String sayHello(){
return "hello,this is my first boot program!!!";
}
}
该类非常简单,只提供了一个接口,并返回一个String 。该类使用了@RestController注解,该注解是一个复合注解,其所包含的比较重要的注解是@Controller 和@ ResponseBody,指定controller 返回的对象自动转化为json 格式并返回(基本类型及其包装类、String 除外)。
###运行Spring Boot 项目
Spring Boot 程序的运行主要有以下两种方式。
- 第一种是使用mvn install 打成jar包,之后使用java -jar运行该jar包(通常在线上部署运行服务的时候使用该方式)。
- 第二种是使用mvn spring-boot:run 运行jar 包(通常在本地IDE 中进行调试的时候使用该方式)。
程序启动成功后,就会在控制台输出以下的两行日志:
2019-12-22 16:41:46.259 INFO 5828 --- [ main] o.s.b.w.embedded.tomcat.TomcatWebServer : Tomcat started on port(s): 8080 (http) with context path ''
2019-12-22 16:41:46.265 INFO 5828 --- [ main] c.m.firstboot.FirstbootApplication : Started FirstbootApplication in 4.417 seconds (JVM running for 7.039)
从第一行可以看出Tomcat 的启动port,第二行是Spring Boot 启动成功的标志。这里还给出了项目启动所花费的时间。
程序启动之后,在浏览器中输入http://localhost:8080/firstboot/sayHello ,
输出为hello, this is my first boot program!!!,则程序运行成功!!!
使用Maven 依赖树验证Spring Boot自动引包功能:mvn dependency:tree
该命令在解决jar 包冲突时很有用。当我们在pom.xml中引入了spring-boot-starter-web
之后,在终端执行mvn dependency:tree
E:\workspace\work-ideaproject\firstboot2>mvn dependency:tree
[INFO] Scanning for projects...
[INFO]
[INFO] ------------------------------------------------------------------------
[INFO] Building firstboot 0.0.1-SNAPSHOT
[INFO] ------------------------------------------------------------------------
[INFO]
[INFO] --- maven-dependency-plugin:3.1.1:tree (default-cli) @ firstboot ---
[INFO] com.microservice:firstboot:jar:0.0.1-SNAPSHOT
[INFO] +- org.springframework.boot:spring-boot-starter-web:jar:2.2.2.RELEASE:compile
[INFO] | +- org.springframework.boot:spring-boot-starter:jar:2.2.2.RELEASE:compile
[INFO] | | +- org.springframework.boot:spring-boot:jar:2.2.2.RELEASE:compile
[INFO] | | +- org.springframework.boot:spring-boot-autoconfigure:jar:2.2.2.RELEASE:compile
[INFO] | | +- org.springframework.boot:spring-boot-starter-logging:jar:2.2.2.RELEASE:compile
[INFO] | | | +- ch.qos.logback:logback-classic:jar:1.2.3:compile
[INFO] | | | | \- ch.qos.logback:logback-core:jar:1.2.3:compile
[INFO] | | | +- org.apache.logging.log4j:log4j-to-slf4j:jar:2.12.1:compile
[INFO] | | | | \- org.apache.logging.log4j:log4j-api:jar:2.12.1:compile
[INFO] | | | \- org.slf4j:jul-to-slf4j:jar:1.7.29:compile
[INFO] | | +- jakarta.annotation:jakarta.annotation-api:jar:1.3.5:compile
[INFO] | | \- org.yaml:snakeyaml:jar:1.25:runtime
[INFO] | +- org.springframework.boot:spring-boot-starter-json:jar:2.2.2.RELEASE:compile
[INFO] | | +- com.fasterxml.jackson.core:jackson-databind:jar:2.10.1:compile
[INFO] | | | +- com.fasterxml.jackson.core:jackson-annotations:jar:2.10.1:compile
[INFO] | | | \- com.fasterxml.jackson.core:jackson-core:jar:2.10.1:compile
[INFO] | | +- com.fasterxml.jackson.datatype:jackson-datatype-jdk8:jar:2.10.1:compile
[INFO] | | +- com.fasterxml.jackson.datatype:jackson-datatype-jsr310:jar:2.10.1:compile
[INFO] | | \- com.fasterxml.jackson.module:jackson-module-parameter-names:jar:2.10.1:compile
[INFO] | +- org.springframework.boot:spring-boot-starter-tomcat:jar:2.2.2.RELEASE:compile
[INFO] | | +- org.apache.tomcat.embed:tomcat-embed-core:jar:9.0.29:compile
[INFO] | | +- org.apache.tomcat.embed:tomcat-embed-el:jar:9.0.29:compile
[INFO] | | \- org.apache.tomcat.embed:tomcat-embed-websocket:jar:9.0.29:compile
[INFO] | +- org.springframework.boot:spring-boot-starter-validation:jar:2.2.2.RELEASE:compile
[INFO] | | +- jakarta.validation:jakarta.validation-api:jar:2.0.1:compile
[INFO] | | \- org.hibernate.validator:hibernate-validator:jar:6.0.18.Final:compile
[INFO] | | +- org.jboss.logging:jboss-logging:jar:3.4.1.Final:compile
[INFO] | | \- com.fasterxml:classmate:jar:1.5.1:compile
[INFO] | +- org.springframework:spring-web:jar:5.2.2.RELEASE:compile
[INFO] | | \- org.springframework:spring-beans:jar:5.2.2.RELEASE:compile
[INFO] | \- org.springframework:spring-webmvc:jar:5.2.2.RELEASE:compile
[INFO] | +- org.springframework:spring-aop:jar:5.2.2.RELEASE:compile
[INFO] | +- org.springframework:spring-context:jar:5.2.2.RELEASE:compile
[INFO] | \- org.springframework:spring-expression:jar:5.2.2.RELEASE:compile
[INFO] \- org.springframework.boot:spring-boot-starter-test:jar:2.2.2.RELEASE:test
[INFO] +- org.springframework.boot:spring-boot-test:jar:2.2.2.RELEASE:test
[INFO] +- org.springframework.boot:spring-boot-test-autoconfigure:jar:2.2.2.RELEASE:test
[INFO] +- com.jayway.jsonpath:json-path:jar:2.4.0:test
[INFO] | +- net.minidev:json-smart:jar:2.3:test
[INFO] | | \- net.minidev:accessors-smart:jar:1.2:test
[INFO] | | \- org.ow2.asm:asm:jar:5.0.4:test
[INFO] | \- org.slf4j:slf4j-api:jar:1.7.29:compile
[INFO] +- jakarta.xml.bind:jakarta.xml.bind-api:jar:2.3.2:test
[INFO] | \- jakarta.activation:jakarta.activation-api:jar:1.2.1:test
[INFO] +- org.junit.jupiter:junit-jupiter:jar:5.5.2:test
[INFO] | +- org.junit.jupiter:junit-jupiter-api:jar:5.5.2:test
[INFO] | | +- org.apiguardian:apiguardian-api:jar:1.1.0:test
[INFO] | | +- org.opentest4j:opentest4j:jar:1.2.0:test
[INFO] | | \- org.junit.platform:junit-platform-commons:jar:1.5.2:test
[INFO] | +- org.junit.jupiter:junit-jupiter-params:jar:5.5.2:test
[INFO] | \- org.junit.jupiter:junit-jupiter-engine:jar:5.5.2:test
[INFO] | \- org.junit.platform:junit-platform-engine:jar:1.5.2:test
[INFO] +- org.mockito:mockito-junit-jupiter:jar:3.1.0:test
[INFO] +- org.assertj:assertj-core:jar:3.13.2:test
[INFO] +- org.hamcrest:hamcrest:jar:2.1:test
[INFO] +- org.mockito:mockito-core:jar:3.1.0:test
[INFO] | +- net.bytebuddy:byte-buddy:jar:1.10.4:test
[INFO] | +- net.bytebuddy:byte-buddy-agent:jar:1.10.4:test
[INFO] | \- org.objenesis:objenesis:jar:2.6:test
[INFO] +- org.skyscreamer:jsonassert:jar:1.5.0:test
[INFO] | \- com.vaadin.external.google:android-json:jar:0.0.20131108.vaadin1:test
[INFO] +- org.springframework:spring-core:jar:5.2.2.RELEASE:compile
[INFO] | \- org.springframework:spring-jcl:jar:5.2.2.RELEASE:compile
[INFO] +- org.springframework:spring-test:jar:5.2.2.RELEASE:test
[INFO] \- org.xmlunit:xmlunit-core:jar:2.6.3:test
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 10.011 s
[INFO] Finished at: 2019-12-22T17:14:43+08:00
[INFO] Final Memory: 27M/227M
[INFO] ------------------------------------------------------------------------
从上述依赖、树可以看出,引入一个web-starter 后, Spring Boot 自动为我们引入了下面几方面的jar 包。
第一个是spring-boot-starter ,该jar 包下包金自动配置的jar, Logback 、SLF4J 的jar及spring-core 。Logback 是Spring Boot 默认使用的日志框架,我们在Spring Boot程序中使用它的时候, 需要在src/main/resources 下添加一个logback.xml 文件,该文件内容如下:
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
<include resource="org/springframework/boot/logging/logback/base.xml"/>
<logger name="org.springframework.web" level="DEBUG"/>
</configuration>
第二个是spring-boot-starter-tomcat ,主要引入一系列tomcat 相关的包。
第三个是hibernate-validator 。
第四个是jackson,引入springmvc 默认使用的json 框架。
第五个是s pring-web 和spring-webmvc 。