一、SpringBoot(一):入门篇
1. 前言
由于原文是基于 SpringBoot 1.3.6 写的,本系列是在原文基础上,根据自己学习需要进行增删改编的“分支” 版本,并改成了markdown格式,与原作略有不同,采用的版本也更新到了SpringBoot 2.1.1 。小段内容不同不做提示,对于大段的自定义内容,我会在标题后面添加(个人)标签区分,对原作更感兴趣的可以移步大大博客查看原文:学习 Spring Boot 知识看这一篇就够了。文章相当精彩,感谢**“微笑”**大大的无私付出~
在学习 Spring Boot 之前,我建议大家先看这三篇文章,了解一下微服务的启蒙。
2. 什么是Spring Boot
Spring Boot是由Pivotal团队提供的全新框架,其设计目的是用来简化新Spring应用的初始搭建以及开发过程。该框架使用了特定的方式来进行配置,从而使开发人员不再需要定义样板化的配置。用我的话来理解,就是Spring Boot其实不是什么新的框架,它默认配置了很多框架的使用方式,就像maven整合了所有的jar包,Spring Boot整合了所有的框架(不知道这样比喻是否合适)。
3. 使用Spring Boot有什么好处
Spring Boot使用**“习惯优于配置”**(项目中存在大量的配置,此外还内置了一个习惯性的配置,让你无需手动进行配置)的理念让你的项目快速运行起来。使用Spring Boot很容易创建一个独立运行(运行jar,内嵌Servlet容器)、准生产级别的基于Spring框架的项目,使用Spring Boot你可以不用或者只需要很少的Spring配置。其实就是简单、快速、方便!
1) 平时如果我们需要搭建一个spring web项目的时候需要怎么做呢?
- 1)配置web.xml,加载spring和spring mvc
- 2)配置数据库连接、配置spring事务
- 3)配置加载配置文件的读取,开启注解
- 4)配置日志文件
- …
- 配置完成之后部署tomcat 调试
- …
现在非常流行微服务,如果我这个项目仅仅只是需要发送一个邮件,如果我的项目仅仅是生产一个积分;我都需要这样折腾一遍!
2) 但是如果使用spring boot呢?
- 自动配置:针对很多Spring应用程序常见的应用功能,Spring Boot能自动提供相关配置
- 起步依赖:告诉Spring Boot需要什么功能,它就能引入需要的库。
- 命令行界面:这是Spring Boot的可选特性,借此你只需写代码就能完成完整的应用程序,无需传统项目构建。
- Actuator:让你能够深入运行中的Spring Boot应用程序,一套究竟。
很简单,我仅仅只需要非常少的几个配置就可以迅速方便的搭建起来一套web项目或者是构建一个微服务!
使用sping boot到底有多爽,用下面这幅图来表达
4. 快速入门
说了那么多,手痒痒的很,马上来一发试试!
1 使用eclipse搭建Springboot项目
maven构建项目
-
1、访问http://start.spring.io/
-
2、选择构建工具Maven Project、Spring Boot版本2.1.1以及一些工程基本信息,点击按钮下方的“Switch to the full version.”会弹出更多选择,java版本默认1.8,可参考下图所示:
-
3、点击Generate Project下载项目压缩包
-
4、解压后导入工程:
使用eclipse
Import -> Existing Maven Projects -> Next ->选择解压后的文件夹-> Finsh,OK done!
使用IDEA
a.菜单中选择
File
–>New
–>Project from Existing Sources...
b.选择解压后的项目文件夹,点击
OK
c.点击
Import project from external model
并选择Maven
,点击Next
到底为止。
项目结构介绍
如上图所示,Spring Boot的基础结构共三个文件:
-
src/main/java 程序开发以及主程序入口
-
src/main/resources 配置文件
-
src/test/java 测试程序
另外,spingboot建议的java文件目录结果如下:
root package结构:com.example.myproject
com
+- example
+- myproject
+- Application.java
|
+- domain
| +- Customer.java
| +- CustomerRepository.java
|
+- service
| +- CustomerService.java
|
+- controller
| +- CustomerController.java
|
-
1、Application.java建议放到跟目录下面,主要用于做一些框架配置
-
2、domain目录主要用于实体(Entity)与数据访问层(Repository)
-
3、service层主要是业务类代码
-
4、controller负责页面访问控制
采用默认配置可以省去很多配置,当然也可以根据自己的喜欢来进行更改
最后,新建启动类,添加Application main启动方法,至此一个java项目搭建好了!
(注意:启动类不能直接放在java目录下,必须放在包里)
引入web模块
1、pom.xml中添加支持web的模块:
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
pom.xml文件中默认有两个模块:
spring-boot-starter
:核心模块,包括自动配置支持、日志和YAML;
spring-boot-starter-test
:测试模块,包括JUnit、Hamcrest、Mockito。
2、编写controller内容:
@RestController
public class HelloWorldController {
@RequestMapping("/hello")
public String index() {
return "Hello World";
}
}
@RestController
的意思就是controller里面的方法都以json格式输出,不用再写什么jackjson配置的了!
3、启动主程序,打开浏览器访问http://localhost:8080/hello,就可以看到效果了,有木有很简单!
如何做单元测试
打开的src/test/下的测试入口,编写简单的http请求来测试;
使用mockmvc进行
@RunWith(SpringJUnit4ClassRunner.class)
@SpringApplicationConfiguration(classes = MockServletContext.class)
@WebAppConfiguration
public class HelloWorldControlerTests {
private MockMvc mvc;
@Autowired
HelloWorldController helloWorldController ;
@Before
public void setUp() throws Exception {
mvc = MockMvcBuilders.standaloneSetup(helloWorldController).build();
}
@Test
public void getHello() throws Exception {
mvc.perform(MockMvcRequestBuilders.get("/hello").accept(MediaType.APPLICATION_JSON))
.andExpect(MockMvcResultMatchers.status().isOk())
.andDo(MockMvcResultHandlers.print())
.andReturn();
}
}
使用SpringBoot注解进行(个人)
SpringBoot项目生成的时候会创建一个测试类DemoApplicationTests ,在之后会详细分析这两种测试,这里仅仅给大家贴上代码
@RunWith(SpringRunner.class)
@SpringBootTest(classes = DemoApplication.class, webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
public class DemoApplicationTests {
@LocalServerPort
private int port;
@Autowired
private TestRestTemplate restTemplate;
private String base;
@Before
public void setUp() throws Exception {
String url = String.format("http://localhost:%d/", port);
System.out.println(String.format("port is : [%d]", port));
this.base = url;
}
/**
* 向"/test"地址发送请求,并打印返回结果
* @throws Exception
*/
@Test
public void contextLoads() {
ResponseEntity<String> response = this.restTemplate.getForEntity(
this.base.toString() + "/method1/getAge", String.class, "");
System.out.println(String.format("测试结果为:%s", response.getBody()));
}
}
开发环境的调试
热启动在正常开发项目中已经很常见了吧,虽然平时开发web项目过程中,改动项目启重启总是报错;但springBoot对调试支持很好,修改之后可以实时生效,需要添加以下的配置:
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-devtools</artifactId>
<optional>true</optional>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<configuration>
<fork>true</fork>
</configuration>
</plugin>
</plugins>
</build>
该模块在完整的打包环境下运行的时候会被禁用。如果你使用java -jar启动应用或者用一个特定的classloader启动,它会认为这是一个“生产环境”。
2 使用IDEA搭建Springboot项目==(个人)==
1.打开IDEA,创建新项目,选择Spring Initializr
2.输入Artifact
3.勾选Web
4.设置路径和名称,点击finish完成
5.进入项目,可以将以下SpringBoot自动生成的文件删除
mvn文件夹
– 存放maven-wrapper.properties和相关jar包
.gitignore
– 分布式版本控制系统git的配置文件,意为忽略提交
在 .gitingore 文件中,遵循相应的语法,在每一行指定一个忽略规则。如:
(前提是服务端没有该文件,才会忽略提交
)
.log
.temp
/vendor
mvnw
– 全名是maven wrapper
它的原理是在maven-wrapper.properties文件中记录你要使用的maven版本,当用户执行mvnw clean 命令时,发现当前用户的maven版本和期望的版本不一致,那么就下载期望的版本,然后用期望的版本来执行mvn命令,比如刚才的mvn clean。
mvn.cmd
– 执行mvnw命令的cmd入口
总而言之,如果你不用git做版本控制,不控制maven版本,这些都可以delete(强迫症受不了!!)
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.example</groupId>
<artifactId>springbootdemo</artifactId>
<version>0.0.1-SNAPSHOT</version>
<packaging>jar</packaging>
<name>springbootdemo</name>
<description>Demo project for Spring Boot</description>
<!--起步依赖-->
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>1.5.2.RELEASE</version>
<relativePath/> <!-- lookup parent from repository -->
</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>
<!--开发web项目相关依赖-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!--springboot单元测试-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
<!--maven构建-->
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
6.创建一个HelloController
@RestController
public class HelloController {
@RequestMapping("/hello")
public String hello() {
return "hello,this is a springboot demo";
}
}
7.程序自动生成的SpringbootdemoApplication,
会有一个@SpringBootApplication的注解,这个注解用来标明这个类是程序的入口
//入口
@SpringBootApplication
public class SpringbootdemoApplication {
public static void main(String[] args) {
SpringApplication.run(SpringbootdemoApplication.class, args);
}
}
@SpringBootApplication开启了Spring的组件扫描和springboot的自动配置功能,相当于将以下三个注解组合在了一起
(1)@Configuration:表名该类使用基于Java的配置,将此类作为配置类
(2)@ComponentScan:启用注解扫描
(3)@EnableAutoConfiguration:开启springboot的自动配置功能
8.运行SpringbootdemoApplication类
测试:
在地址栏中输入http://localhost:8080/hello
9.使用启动jar包的方式启动
(1)首先进入项目所在目录,如果是mac系统在项目上右键,选择Reveal in Finder,Windows系统在项目上右键选择Show in Explorer,即可打开项目所在目录
(2)打开终端,进入项目所在目录
cd /Users/shanml/IdeaProjects/SpringbootDemo
输入mvn install,构建项目
(3)构建成功后,在项目target文件夹下会多出一个jar包
(4)使用java -jar springbootdemo-0.0.1-SNAPSHOT.jar
启动jar包即可
总结
使用spring boot可以非常方便、快速搭建项目,使我们不用关心框架之间的兼容性,适用版本等各种问题,我们想使用任何东西,仅仅添加一个配置就可以,所以使用sping boot非常适合构建微服务。
文中所有的代码https://github.com/ityouknow/spring-boot-starter
PS:博文仅作为个人学习笔记,如有错误欢迎指正,转载请注明出处~
更多博文详见:
参考文档: