文档章节

用Spring Boot 构建项目中遇到问题及解决方法

wlc534
 wlc534
发布于 2017/05/18 17:55
字数 4053
阅读 299
收藏 0

Spring Boot是由Pivotal团队提供的全新框架,其设计目的是用来简化新Spring应用的初始搭建以及开发过程。该框架使用了特定的方式来进行配置,从而使开发人员不再需要定义样板化的配置。通过这种方式,Boot致力于在蓬勃发展的快速应用开发领域(rapid application development)成为领导者。

Spring Boot的主要优点:

Spring Boot提供了一个强大的一键式Spring的集成开发环境,能够单独进行一个Spring应用的开发,其中: 

(1)集中式配置(application.properties)+注解,大大简化了开发流程 
(2)内嵌的Tomcat(默认)和Jetty容器,可直接打成jar包启动,无需提供Java war包以及繁琐的Web配置 
(3)提供了Spring各个插件的基于Maven的pom模板配置,开箱即用,便利无比。 
(4)可以在任何你想自动化配置的地方,实现可能 
(5)提供更多的企业级开发特性,如何系统监控,健康诊断,权限控制 
(6)无冗余代码生成和XML强制配置 
(7)提供支持强大的Restfult风格的编码,非常简洁 

工程结构(最佳实践)

Spring Boot框架本身并没有对工程结构有特别的要求,但是按照最佳实践的工程结构可以帮助我们减少可能会遇见的坑,尤其是Spring包扫描机制的存在,如果您使用最佳实践的工程结构,可以免去不少特殊的配置工作。

典型示例

       · root package结构:com.example.myproject

       · 应用主类Application.java置于root package下,通常我们会在应用主类中做一些框架配置扫描等配置,我们放在root package下可以帮助程序减少手工配置来加载到我们希望被Spring加载的内容

       · 实体(Entity)与数据访问层(Repository)置于com.example.myproject.domain包下

       · 逻辑层(Service)置于com.example.myproject.service包下

       · Web层(web)置于com.example.myproject.controller包下

com

  +- example

    +- myproject

      +- Application.java

      |

      +- domain

      |  +- Customer.java

      |  +- CustomerRepository.java

      |

      +- service

      |  +- CustomerService.java

      |

      +- web

      |  +- CustomerController.java

      |

 

 

 

 

public static void main(String[] args)

需要注意的地方如下: 

在src/main/java包下的第一层结构中,是必须放一个含有main方法的主启动的类,而且只能有一个main方法,如果再出现其他的main方法,在使用maven编译打包时,会报编译错误,当然在src/test/java包下,可以出现多个,但建议最好使用Junit进行单元测试. (这就是刚开始项目构建出现了多个main方法,结果项目一启动就报错。)
这个main方法启动,就会启动内嵌的tomcat或jetty容器,然后加载所有需要加载的或扫描的类或资源文件。

热部署

构建项目之初,编写、修改每次都要重新启动main。非常麻烦、效率还很低。对于运维、开发人员来说,热部署是常常要思考的一个问题。热部署简单来说,就是局部或者某个文件修改后,不用重新启动程序,立即生效。好处在于在程序初始化的时候可能会加载大量的初始化数据,重启程序成本太高;程序如果是项目中的单个模块,重启会影响别的应用。对于web程序来说,大多是部署在Servlet容器里面,如jBoss,weblogic,tomcat等,这些容器往往提供了配套的热部署方案。

但对于application程序,往往没有厂家单独来做这件事情。

找到两种解决方法。

 

Springloaded

1、下载SpringLoad jar包:

 

spring-loaded(https://github.com/spring-projects/spring-loaded)

maven依赖:(可不配置)

1

2

3

4

5

<dependency>

            <groupid>org.springframework</groupid>

            springloaded</artifactid>

            <version>1.2.3.RELEASE</version>

        </dependency>

2、在项目根目录下创建repo目录,将springloaded-1.2.3.RELEASE.jar放到下面。

 

3、如果是eclipse,就在主类的run configuration里面添加JVM启动参数:

1

-javaagent:repo/springloaded-1.2.3.RELEASE.jar -noverify

 

注意路径。

 

如果是在eclipse里面,记得勾选自动编译。 Project Automatically。

启动后,修改java代码,将会立即生效。

 

 

spring-boot-devtools(推荐)

使用springloaded进行热部署,但是有部分代码修改了,并不会进行部署。现在介绍的这个通过重启的机制就可以解决这个问题了。要介绍的就是:spring-boot-devtools

spring-boot-devtools 是一个为开发者服务的一个模块,其中最重要的功能就是自动应用代码更改到最新的App上面去。原理是在发现代码有更改之后,重新启动应用,但是比速度比手动停止后再启动还要更快,更快指的不是节省出来的手工操作的时间。

其深层原理是使用了两个ClassLoader,一个Classloader加载那些不会改变的类(第三方Jar包),另一个ClassLoader加载会更改的类,称为  restart ClassLoader

,这样在有代码更改的时候,原来的restart ClassLoader 被丢弃,重新创建一个restart ClassLoader,由于需要加载的类相比较少,所以实现了较快的重启时间(5秒以内)。

那如何使用呢,大概两个步骤即可:

第一就是添加相应的依赖:

<!--

           devtools可以实现页面热部署(即页面修改后会立即生效,这个可以直接在application.properties文件中配置spring.thymeleaf.cache=false来实现),    

           实现类文件热部署(类文件修改后不会立即生效),实现对属性文件的热部署。 

           即devtools会监听classpath下的文件变动,并且会立即重启应用(发生在保存时机),注意:因为其采用的虚拟机机制,该项重启是很快的    

        -->

       <dependency>

            <groupId>org.springframework.boot</groupId>

            <artifactId>spring-boot-devtools</artifactId>

            <optional>true</optional>

        </dependency>

 

 

第二加点:仅仅加入devtools在我们的eclipse中还不起作用,这时候还需要添加的spring-boot-maven-plugin:

<build>

       <plugins>

           <!--

             用于将应用打成可直接运行的jar(该jar就是用于生产环境中的jar) 值得注意的是,如果没有引用spring-boot-starter-parent做parent,

                       且采用了上述的第二种方式,这里也要做出相应的改动

             -->

            <plugin>

                <groupId>org.springframework.boot</groupId>

                <artifactId>spring-boot-maven-plugin</artifactId>

                <configuration>

                   <!--fork :  如果没有该项配置,那个devtools不会起作用,即应用不会restart -->

                    <fork>true</fork>

                </configuration>

            </plugin>

       </plugins>

   </build>

 

 

运行App.java  ---- Run Application --- Java Application即可进行测试。

测试方法:

·         修改类-->保存:应用会重启

·         修改配置文件-->保存:应用会重启

·         修改页面-->保存:应用会重启,页面会刷新(原理是将spring.thymeleaf.cache设为false)

不能使用分析:

(a)     对应的spring-boot版本是否正确,我这里使用的是1.4.1版本;

(b)     是否加入plugin了,以及属性<fork>true</fork>

(c)      Eclipse Project 是否开启了Build Automatically(我自己就在这里栽了坑,不知道为什么我的工具什么时候关闭了自动编译的功能)。

(d)     如果设置SpringApplication.setRegisterShutdownHook(false),则自动重启将不起作用。

补充:

默认情况下,/META-INF/maven,/META-INF/resources,/resources,/static/templates,/public这些文件夹下的文件修改不会使应用重启,但是会重新加载(devtools内嵌了一个LiveReload server,当资源发生改变时,浏览器刷新)。

·         如果想改变默认的设置,可以自己设置不重启的目录:spring.devtools.restart.exclude=static/**,public/**,这样的话,就只有这两个目录下的文件修改不会导致restart操作了。

·         如果要在保留默认设置的基础上还要添加其他的排除目录:spring.devtools.restart.additional-exclude

·         如果想要使得当非classpath下的文件发生变化时应用得以重启,使用:spring.devtools.restart.additional-paths,这样devtools就会将该目录列入了监听范围。

关闭自动重启

设置 spring.devtools.restart.enabled 属性为false,可以关闭该特性。可以在application.properties中设置,也可以通过设置环境变量的方式。

publicstaticvoidmain(String[] args){

    System.setProperty("spring.devtools.restart.enabled","false");

SpringApplication.run(MyApp.class, args);

引入号称性能最好的JDBC连接池:HikariCP

SpringBoot默认使用 org.apache.tomcat.jdbc.pool.DataSource 

现在有个叫 HikariCP 的JDBC连接池组件,据说其性能比常用的 c3p0、tomcat、bone、vibur 这些要高很多。 我打算把工程中的DataSource变更为HirakiDataSource,做法很简单: 

首先在application.properties配置文件中指定dataSourceType

spring.datasource.type=com.zaxxer.hikari.HikariDataSource

 

然后在pom中添加Hikari的依赖

<dependency>
    <groupId>com.zaxxer</groupId>
    <artifactId>HikariCP</artifactId>
    <!-- 版本号可以不用指定,Spring Boot会选用合适的版本 -->
</dependency>

 

为了安全排除默认自带的tomcat 连接池 可以这么操作

默认是用Tomcat 连接池 

如果想使用HikariCP的话 在引用 spring-boot-starter-jdbc时排除tomcat-jdbc就好了

pom文件如下:

    <dependency>

        <groupId>org.springframework.boot</groupId>

        <artifactId>spring-boot-starter-jdbc</artifactId>

        <exclusions>

            <exclusion>

                <!-- 取消引入tomcat jdbc -->

                <groupId>org.apache.tomcat</groupId>

                <artifactId>tomcat-jdbc</artifactId>

            </exclusion>

        </exclusions>

    </dependency>

 

Spring Boot 集成mybatis

Springboot默认集成了springJDBC与JPA,但是没有集成mybatis,所以想要使用mybatis就要自己去集成。此处提供最简单的方法。具体如下

使用starter配置

1步:引入mybatis的starter的包。

 Spring Boot将封装的一系列支持boot的应用的工程都叫做starter,我们这里引入mybatis对boot的支持的starter。如果是同一个的pom, starter会自动引入依赖包。

pom.xml

<dependency>
    <groupId>org.mybatis.spring.boot</groupId>
    <artifactId>mybatis-spring-boot-starter</artifactId>
    <version>1.1.1</version>
</dependency>

 

 

2步:配置properties。

spring.datasource.url=jdbc:mysql://localhost:3306/studysql?useUnicode=true&characterEncoding=utf-8

 

spring.datasource.username=root

spring.datasource.password=root

spring.datasource.driver-class-name=com.mysql.jdbc.Driver

 

#spring.devtools.restart.enabled=false   自动部署开关

 

#HikariCP  HikariCP号称是现在性能最好的JDBC连接池组件

#spring.datasource.type=com.zaxxer.hikari.HikariDataSource

 

#server.port=8090   服务器端口

 

spring.data.mongodb.uri=mongodb://mrcacheopr:mrcacheopr@10.20.130.34:22801/mrcache

 

mybatis.mapperLocations=classpath:mapper/*.xml

mybatis.typeAliasesPackage=com.pingan.mario.domain

 

 

说明: 

1: spring.开头的是spring boot自动配置的属性开头,后面我们会讨论怎么自定义自己类型安全的配置项。 

2: 这是mybatis配置的自动配置的属性。

xml配置扫描、动态SQL处理

Spring boot 官方推荐无xml配置,而mybatis 官方推荐是xml配置去处理SQL。这是一对矛盾体。在Spring Boot中整合MyBatis时,采用了注解的配置方式,相信很多人还是比较喜欢这种优雅的方式的。  使用mybatis的主要目的,就是解决复杂sql。在数据库工具中拼写好sql,拷贝进xml文件;验证sql,仅需要把sql拷贝到数据库工具进行分析即可,简单高效。在mybatis中可以使用注解的方式去处理多表关联复杂查询、也可以处理动态SQl。

综上我们的微服务使用XML配置(复杂的)+注解(简单的)。其中有一些注意点;

配置properties

mybatis.mapperLocations=classpath:mapper/*.xml

mybatis.typeAliasesPackage=com.pingan.mario.domain

 

与普通的mybatis配置一样,只是小心:

1、mapper的命名空间(namespace),一定是所对应的接口的包名+类名

2、parameterType和resultMap,与实际匹配

3、为了避免在每个mapper接口上注解@Mapper,可以@MapperScan注解,指定扫描的mapper接口所在的包。

如@MapperScan("com.pingan.mario.domain") //扫描这个包项目接口Mapper 接口

4、配置中的mybatis.mapperLocations=classpath:mapper/*.xml 要注意xml的路径,不然各种找不到启动报错。

Spring Boot中使用Swagger2构建强大的RESTful API文档

由于Spring Boot能够快速开发、便捷部署等特性,相信有很大一部分Spring Boot的用户会用来构建RESTful API。而我们构建RESTful API的目的通常都是由于多终端的原因,这些终端会共用很多底层业务逻辑,因此我们会抽象出这样一层来同时服务于多个移动端或者Web前端。

这样一来,我们的RESTful API就有可能要面对多个开发人员或多个开发团队:IOS开发、Android开发或是Web开发等。为了减少与其他团队平时开发期间的频繁沟通成本,传统做法我们会创建一份RESTful API文档来记录所有接口细节,然而这样的

做法有以下几个问题:

  • 由于接口众多,并且细节复杂(需要考虑不同的HTTP请求类型、HTTP头部信息、HTTP请求内容等),高质量地创建这份文档本身就是件非常吃力的事,下游的抱怨声不绝于耳。
  • 随着时间推移,不断修改接口实现的时候都必须同步修改接口文档,而文档与代码又处于两个不同的媒介,除非有严格的管理机制,不然很容易导致不一致现象。

为了解决上面这样的问题,本文将介绍RESTful API的重磅好伙伴Swagger2,它可以轻松的整合到Spring Boot中,并与Spring MVC程序配合组织出强大RESTful API文档。

它既

可以减少我们创建文档的工作量

同时说明内容又整合入实现代码中

让维护文档和修改代码整合为一体,可以让我们在修改代码逻辑的同时方便的修改文档说明。另外

Swagger2也提供了强大的页面测试功能来调试每个RESTful API。具体效果如下图所示:

 

添加Swagger2依赖:

在pom.xml中加入Swagger2的依赖

<dependency>

    <groupId>io.springfox</groupId>

    <artifactId>springfox-swagger2</artifactId>

    <version>2.5.0</version>

</dependency>

<dependency>

    <groupId>io.springfox</groupId>

    <artifactId>springfox-swagger-ui</artifactId>

    <version>2.5.0</version>

</dependency>

创建Swagger2配置类

在MarioCoreServiceApplication.java同级创建Swagger2的配置类Swagger2

@Configuration

@EnableSwagger2

public class Swagger2 {

    @Bean

    public Docket createRestApi() {

        return new Docket(DocumentationType.SWAGGER_2)

                .apiInfo(apiInfo())

                .select()

                .apis(RequestHandlerSelectors.basePackage("com.didispace.web"))

                .paths(PathSelectors.any())

                .build();

    }

    private ApiInfo apiInfo() {

        return new ApiInfoBuilder()

                .title("Spring Boot中使用Swagger2构建RESTful APIs")

                .description("更多Spring Boot ")

                .termsOfServiceUrl("http://xxx.com/")

                .contact("测试")

                .version("1.0")

                .build();

    }

}

 

如上代码所示,通过@Configuration注解,让Spring来加载该类配置。再通过@EnableSwagger2注解来启用Swagger2。

再通过createRestApi函数创建Docket的Bean之后,apiInfo()用来创建该Api的基本信息(这些基本信息会展现在文档页面中)。select()函数返回一个ApiSelectorBuilder实例用来控制哪些接口暴露给Swagger来展现,本例采用指定扫描的包路径来定义,Swagger会扫描该包下所有Controller定义的API,并产生文档内容(除了被@ApiIgnore指定的请求)。

添加文档内容

在完成了上述配置后,其实已经可以生产文档内容,但是这样的文档主要针对请求本身,而描述主要来源于函数等命名产生,对用户并不友好,我们通常需要自己增加一些说明来丰富文档内容。如下所示,我们通过@ApiOperation注解来给API增加说明、通过@ApiImplicitParams、@ApiImplicitParam注解来给参数增加说明。

@RestController

@EnableSwagger2

//@RequestMapping(value="/mario")

public class SampleController {

       @Autowired

       private UserService userService;

    @RequestMapping(value = "/getUser",method=RequestMethod.GET)

    public String findByName(@RequestParam(value="name") String name) {

          

           User u = userService.selectByUsername(name);

           System.out.println("通过XML配置及service:"+u.toString());

           return u.toString();

    }

  @ApiOperation(value="测试Swagger API",notes="这是通过name 获取对应的User")

  @RequestMapping(value = "/getAll",method=RequestMethod.GET)

       public String findAll(

                     @ApiParam(required=true,name="name",value="姓名") //参数 解释

                     @RequestParam(value="name",defaultValue="中国") String name) {

              List<User> userLisr = userService.findAll(name);

              for (User user : userLisr) {

                     System.out.println(user.toString());

              }

              return userLisr.get(0).toString();

       }

完成上述代码添加上,启动Spring Boot程序,访问:http://localhost:8080/swagger-ui.html
。就能看到前文所展示的RESTful API的页面。我们可以再点开具体的API请求,以POST类型的/users请求为例,可找到上述代码中我们配置的Notes信息以及参数user的描述信息,如下图所示。

 

API文档访问与调试

在上图请求的页面中,我们看到user的Value是个输入框?是的,Swagger除了查看接口功能外,还提供了调试测试功能,我们可以点击上图中右侧的Model Schema(黄色区域:它指明了User的数据结构),此时Value中就有了user对象的模板,我们只需要稍适修改,点击下方“Try it out!”按钮,即可完成了一次请求调用!

此时,你也可以通过几个GET请求来验证之前的POST请求是否正确

相比为这些接口编写文档的工作,我们增加的配置内容是非常少而且精简的,对于原有代码的侵入也在忍受范围之内。因此,在构建RESTful API的同时,加入swagger来对API文档进行管理,是个不错的选择。

 

 

© 著作权归作者所有

wlc534
粉丝 9
博文 85
码字总数 144683
作品 0
私信 提问
Spring Boot 获得帮助

如果你在使用 Spring Boot 的时候遇到了问题,我们很乐意为你提供帮助。 请访问 IX. How-to指南 中的内容 — 在这个指南中为常见的多数问题提供了解决方案。 学习更多有关 Spring 的基础知识...

honeymose
2018/12/03
0
0
Spring Boot 2.0干货系列:(一)Spring Boot1.5X升级到2.0指南

前言 Spring Boot已经发布2.0有4个月多,多了很多新特性,一些坑也慢慢被填上,最近有空,就把本博客中Spring Boot干货系列对应的源码从1.5X升级到Spring Boot 2.0,顺便整理下升级的时候遇到...

嘟爷MD
2018/07/24
0
0
SpringBoot(一)之快速入门

一、Spring Boot 久闻Spring Boot大名,这两天终于得空,学习了一把,发觉Spring Boot确实好用,那Spring Boot到底是什么,又是怎么好用呢? 什么是Spring Boot 目前ssm框架还是比较常用的,...

郑加威
2018/12/23
0
0
Spring Boot 和 testNG 和 eclipse背景色

通过之前的博文,我们已经验证,Spring环境下完成access数据访问没有问题。下面我们直接在Spring环境下部署我们的升级项目。 1.导入Spring Boot Spring Boot是Spring的子项目,用来解决项目配...

pandamonica
2017/09/19
0
0
spring boot(1)入门

1 简介 Spring Boot是由Pivotal团队提供的全新框架,其设计目的是用来简化新Spring应用的初始搭建以及开发过程。该框架使用了特定的方式来进行配置,从而使开发人员不再需要定义样板化的配置...

刘胜球
2017/10/25
0
0

没有更多内容

加载失败,请刷新页面

加载更多

数组算法

/*数组的相关的算法操作:1、在数组中找最大值/最小值*/class Test11_FindMax{public static void main(String[] args){int[] array = {4,2,6,8,1};//在数组中找最大...

architect刘源源
25分钟前
0
0
okhttp3 以上版本在安卓9.0无法请求数据的解决方案

应用官方的说明:在 Android 6.0 中,我们取消了对 Apache HTTP 客户端的支持。 从 Android 9 开始,默认情况下该内容库已从 bootclasspath 中移除且不可用于应用。且Android P 限制了明文流量...

chenhongjiang
今天
5
0
简单示例:NodeJs连接mysql数据库

开篇引用网上的说法: 简单的说 Node.js 就是运行在服务端的 JavaScript。Node.js 是一个基于Chrome JavaScript 运行时建立的一个平台。Node.js是一个事件驱动I/O服务端JavaScript环境,基于...

李朝强
今天
8
0
大数据学习路线

年薪30W大数据学习路线图: 一、Hadoop入门,了解什么是Hadoop 1、Hadoop产生背景 2、Hadoop在大数据、云计算中的位置和关系 3、国内外Hadoop应用案例介绍 4、国内Hadoop的就业情况分析及课程...

陈小君
今天
3
0
解读 Kylin 3.0.0 | 更敏捷、更高效的 OLAP 引擎

在近期的 Apache Kylin Meetup 成都站上,我们邀请到 Kyligence 架构师 & Apache Kylin Committer 倪春恩对 Kylin 3.0.0 版本的一些重要功能及改进从使用到原理进行了介绍: Apache Kylin 在...

ApacheKylin
今天
6
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部