1.2 通过Maven开发第一个Spring Boot项目
用传统Spring框架开发项目,虽然各项目的业务功能点不同,但是它们会有不少相同的配置文件。新创建一个Spring项目时,我们不得不复制这些配置文件,对架构师(或高级开发)来说,这种“代码粘贴”动作是需要尽量避免的。Spring Boot能有效地解决这类问题。
Spring Boot没有“颠覆性”地改变Spring框架,而是通过引入Maven和“自动化配置”等方式来简化配置文件。它不仅能让开发者在新建项目时减少配置文件方面的工作量,还能进一步降低项目中类和jar包之间的依赖关系,它的价值在于“能减轻程序员在开发和配置项目中的工作量”。
1.2.1 Maven是什么,能带来什么帮助
我们在用Eclipse开发项目时,一定会引入支持特定功能的jar包,比如从图1.4中,我们能看到这个项目需要引入支持mysql的jar包。
图1.4 在项目里引入jar包的示意图
从图1.4中我们能看到,支持mysql的jar包是放在本地路径里的,这样在本地运行时自然是没问题的,但要把这个项目发布到服务器上就会有问题了,因为在这个项目的.classpath文件已经指定mysql的jar包在本地D盘下的某个路径中,如图1.5所示。
图1.5 指定jar路径的classpath文件的片段
一旦发布到服务器上,项目依然会根据.classpath的配置从D盘下的这个路径去找,事实上服务器上是不可能有这样的路径和jar包的。
我们也可以通过在.classpath里指定相对路径来解决这个问题,在下面的代码里,我们可以指定本项目将引入“本项目路径/WebRoot/lib”目录里的jar包。
<classpathentry kind="lib" path="WebRoot/lib/jar包名.jar"/>
这样做,发布到服务器时,由于会把整个项目路径里的文件都上传,因此不会出错。但这样依然会给我们带来不便。比如这个服务器上我们部署了5个项目,它们都会用到这个mysql支持包,这样我们就不得不把这个jar包上传5次。再扩展一下,如果5个项目里会用到20个相同的jar包,那么我们还真就不得不做多次复制。如果我们要升级其中的一个jar包,那么还真就得做很多重复的复制粘贴动作。
期望中的工作模式应该是,有一个“仓库”统一放置所有的jar包,在开发项目时,可以通过配置文件引入必要的包,而不是把包复制到本项目里。这就是Maven的做法。
用通俗的话来讲,Maven是一套Eclipse的插件,它的核心价值是能理顺项目间的依赖关系,具体来讲,能通过其中的pom.xml配置文件来统一管理本项目所要用到的jar包,在项目里引入Maven插件后,开发者就不必手动添加jar包了,这样也能避免因此来带来的一系列问题。
1.2.2 通过Maven开发Spring Boot的HelloWorld程序
在这个案例中,大家不仅可以理解如何开发Spring Boot的程序,更能理解Maven的一般用法。
第一步,创建Maven项目。本书使用MyEclipse作为开发环境,在其中已经引入了Maven插件,所以我们可以通过“File”→“New”菜单,直接创建Maven项目,如图1.6所示。
图1.6 在MyEclipse里创建Maven项目的示意图
在图1.6中,单击“Next”按钮后,会见到如图1.7所示的界面,在其中我们可以设置Group Id等属性。
图1.7 设置Maven各属性的示意图
其中,Group Id代表公司名(也叫组织名),这里设置成“com.springBoot”;Artifact Id是项目名;Version和Packag采用默认值。一般来说,通过Group Id、Artifact Id和Version就能定位到唯一的jar包。完成设置后,能看到新建的项目MyFirstSpringBoot,如图1.8所示。
图1.8 创建好的Maven项目示意图
第二步,改写pom.xml。当我们创建好Maven项目后,在其中能看到pom.xml文件。在Maven项目里一般是通过pom.xml来指定本项目的基本信息以及需要引入的jar依赖包,关键代码如下:
其中,第1~4行的代码是自动生成的,用来指定本项目的基本信息,这和我们在之前创建Maven项目时所填的信息是一致的。
从第7~19行的dependencies属性里,我们可以指定本项目所用到的jar包,在第8和第13行分别通过两个dependency来指定该引入两类jar包。其中,第8~12行指定了需要引入用以开发Spring Boot项目的名为spring-boot-starter-web的jar的集合,第13~18行指定了需要引入用以单元测试的junit包。
从上述代码中,我们能见到通过Maven管理项目依赖文件的一般方式。比如在下面的代码片段里,通过第2~4行的代码说明需要引入org.springframework.boot这个公司组织(发布Spring Boot jar包的组织)发布的名为spring-boot-starter-web的一套支持Spring Boot的jar包,而且通过第4行指定了引入包的版本号是1.5.4.RELEASE。
这样一来,在本项目里,我们就不用再手动地添加jar包,这些包实际上是存放在本地的jar包仓库里的,也就是说,在项目里是通过pom.xml的配置来指定需要引入这些包。
第三步,改写App.java。在创建项目时,指定的package是com.springboot.MyFirstSpringBoot,在其中会有一个App.java,我们把这个文件改写成如下样式。
由于是第一次使用Maven,我们在这里再强调一次,虽然我们没有在项目里手动地引入jar,但是在pom.xml里指定了待引入的依赖包,具体而言就是需要依赖org.springframework.boot组织所提供的spring-boot-starter-web,所以在代码的第2~5行里,我们可以通过import语句,使用spring-boot-starter-web(也就是Spring Boot)的类库。
在第8行里,我们引入了@SpringBootApplication注解,以此声明该类是一个基于Spring Boot的应用。
在第10~13行的代码里,我们通过@RequestMapping指定了用于处理/HelloWorld请求的sayHello方法,在第14行的main函数里,我们通过第15行的代码启动了Web服务。
至此,我们完成了代码编写工作。启动MyFirstSpringBoot项目里的App.java,在浏览器里输入“http://localhost:8080/HelloWorld”。
由于/HelloWorld请求能被第11~13行的sayHello方法的@RequestMapping对应上,所以会通过sayHello方法输出“Hello World!”的内容,如图1.9所示。
图1.9 HelloWorld程序运行效果图
从这个程序里,我们能体会到开发Spring Boot和传统Spring程序的不同。
第一,在之前的Spring MVC框架里,我们不得不在web.xml中定义采用Spring的监听器,而且为了采用@Controller控制器类,我们还得加上一大堆配置,但在Spring Boot里,我们只需要添加一个@SpringBootApplication注解。
第二,我们往往需要把传统的Spring MVC项目发布到诸如Tomcat的Web服务器上,启动Web服务器后我们才能在浏览器里输入请求查看运行的效果;这里我们只需启动App.java这个类即可达到类似的效果。
1.2.3 Controller类里处理Restful格式的请求
之前我们已经提到过,微服务模块间一般是通过Restful格式的请求来交互,在表1.2里,我们能看到各种Restful请求的格式。
表1.2 常用Restful格式请求的功能归纳表
其中,Get等都是基于HTTP协议的请求。具体而言,如果我们指定请求类型是Get,并设置请求url是/accounts/123,那么我们就能得到id是123的账户信息,如果发的是Get类型的/accounts,就返回所有的账户。
在SpringBootRestfulDemo案例中,我们将向大家演示在Spring Boot里编写支持Restful格式请求的服务类的一般方法,同样,这里我们用Maven来创建项目。
在这个项目里,我们用和刚才MyFirstSpringBoot一样的方法创建Maven项目,只是这里的artifactId需要填写成本项目的名字SpringBootRestfulDemo。这个项目的pom.xml和MyFirstSpringBoot项目里的一致,同样是引入Spring Boot的依赖包。在这个项目的App.java的main函数里,我们同样加入了启动代码,如下所示。
在这个项目中,我们需要定义描述账户信息的Account类,代码如下所示。
在RestfulController.java里,我们将定义处理各种Restful格式请求的方法,代码如下所示。
在上述代码里,我们在每个方法的@RequestMapping注解里,不仅指定了触发该方法的url请求格式,还指定了能触发该方法的请求类型。
在正式的项目里,我们是从数据源(比如Account数据表)里获取数据,这里我们用HashMap来代替数据库,所有的增、删、改、查都是针对上文第6行定义的accounts对象。
这里我们通过url的形式简易演示一下“Get”形式请求的运行效果。启动App.java后,在浏览器里输入“http://localhost:8080/account/1”,我们能看到Json格式的返回效果,如图1.10所示。
图1.10 Get请求返回的效果图
这里的请求其实是触发了第20行的getAccount方法,至于Post等其他格式的请求,无法通过浏览器的形式简单地调用,所以这里只给出实现代码,在后文里,我们将详细地给出调用方法。
1.2.4 @SpringBootApplication注解等价于其他3个注解
Spring Boot和传统的Spring框架一样,是通过注解来降低类(以及模块)之间的耦合,在其中,@SpringBootApplication这个注解用得比较多,因为我们一般用它来启动应用项目。
事实上它是一个复合注解,等价于@ComponentScan、@SpringBootConfiguration和@EnableAutoConfiguration。
· @ComponentScan继承于@Configuration,用来表示程序启动时将自动扫描当前包及子包下的所有类。
· @SpringBootConfiguration表示将会把本类里声明的一个或多个以@Bean注解标记的实例纳入Spring容器中。
· @EnableAutoConfiguration用来表示程序启动时将自动地装载springboot默认配置文件。
1.2.5 通过配置文件实现热部署
如果我们每次在修改完Spring Boot里的Java或配置文件后都需要重启诸如App.java这样的启动类才能生效,那么这样的开发效率未免太低。在实际的开发过程中,我们可以通过修改pom.xml的方式来实现热部署。
以刚才的SpringBootRestfulDemo项目为例,为了实现热部署,我们需要把pom.xml修改如下:
当我们在pom.xml添加完第3~7行的代码后,启动App.java,这时我们能看到如下输出。
1 {"id":1,"accountName":"Tom"}
注意,此时别停服务,直接修改getAccount方法,把第6行参数修改成“Peter”,如下所示。
此时如果我们再往浏览器里输入http://localhost:8080/account/1,那么输出就变成“Peter”了,也就是说,无须重启App启动类,即能看到修改后的效果。
1 {"id":1,"accountName":"Peter"}