SpringBoot学习总结Word格式.docx

1、providedorg.apache.tomcat.embedtomcat-embed-jasper启动类上班必须有SpringBootApplication注解,controller类要加RestController注解,方法上配置RequestMaping注解SpringBootApplicationpublic class Application public static void main（String args） SpringApplication.run（Application.class, args）; 注解与模板讲解:Controller注解:处理http请求RestCont

2、roller注解:Spring4之后新加的注解,等同于返回json注解的ResponseBody+controller注解的组合注解RequestMapping注解:配置url配置PathVariable 获取url中的数据RequestParam 获取请求参数的值如果仅仅使用Controller,返回的字符串就是页面的名称,需要加入srping官方的模板引擎,在pom.xml中配置,spring-boot-starter-thymeleaf属性配置application.properties为springboot的默认配置文件,可配置端口server.port=8081可配置项目路径serv

3、er.context-path=/gril ,访问路径时的路径就变成localhost:8081/gril/controller名称application.yml文件是springboot的另一种配置文件,这种文件可以减少重复值（推荐,注意:冒号后要加空格）server: port: 8080 context-path: /gril在yml文件中自定义属性时,在controller中使用Value（“$gril”）yml:gril:liuyandengcontroller:Value（“$gril”）private String gril;（配置文件中部分类型,如果是数字类型可以写成priva

4、te integer lyd;）属性映射到bean name: liuyandeng age: 25创建Gril.java的java文件,类上加Component和ConfigurationProperties（prefix=gril）,创建private String name;和private Integer age;属性 创建get和set方法,获取配置文件前缀是gril的配置映射到javabean属性中,在controller中注入这个bean Autowired Girl gril ;如果有多个配置文件比如application.yml,application-A.yml和appli

5、cation-B.yml,如果想使用B配置文件,可在application.yml文件中配置spring: profiles: active: B数据库操作 thymeleaf: prefix: /WEB-INF/views/ suffix: .html mode: HTML5 encoding: UTF-8 content-type: text/html cache: false datasource: test url: jdbc:mysql:/localhost:3306/cgfy-springBoot?useUnicode=true&characterEncoding=UTF-

6、8 username: root password: 123456 # 使用druid数据源 type: com.alibaba.druid.pool.DruidDataSource driver-class-name: com.mysql.jdbc.Driver minIdle: 1 maxActive: 20 initialSize: timeBetweenEvictionRunsMillis: 3000 minEvictableIdleTimeMillis: 300000 testWhileIdle: true testOnBorrow: testOnReturn:mybatis: ma

7、pperLocations: classpath*:mapper/*.xml typeAliasesPackage: com.jeff.modelJAP（Java Persistence API）定义了一系列对象持久化的标准,目前实现这一规范的产品有hibernate,toplink等Spring Boot中使用Swagger2构建强大的RESTful API文档由于Spring Boot能够快速开发、便捷部署等特性，相信有很大一部分Spring Boot的用户会用来构建RESTful API。而我们构建RESTful API的目的通常都是由于多终端的原因，这些终端会共用很多底层业务逻辑，因此

8、我们会抽象出这样一层来同时服务于多个移动端或者Web前端。这样一来，我们的RESTful API就有可能要面对多个开发人员或多个开发团队：IOS开发、Android开发或是Web开发等。为了减少与其他团队平时开发期间的频繁沟通成本，传统做法我们会创建一份RESTful API文档来记录所有接口细节，然而这样的做法有以下几个问题：由于接口众多，并且细节复杂（需要考虑不同的HTTP请求类型、HTTP头部信息、HTTP请求内容等），高质量地创建这份文档本身就是件非常吃力的事，下游的抱怨声不绝于耳。随着时间推移，不断修改接口实现的时候都必须同步修改接口文档，而文档与代码又处于两个不同的媒介，除非有严格

9、的管理机制，不然很容易导致不一致现象。为了解决上面这样的问题，本文将介绍RESTful API的重磅好伙伴Swagger2，它可以轻松的整合到Spring Boot中，并与Spring MVC程序配合组织出强大RESTful API文档。它既可以减少我们创建文档的工作量，同时说明内容又整合入实现代码中，让维护文档和修改代码整合为一体，可以让我们在修改代码逻辑的同时方便的修改文档说明。另外Swagger2也提供了强大的页面测试功能来调试每个RESTful API。具体效果如下图所示：下面来具体介绍，如果在Spring Boot中使用Swagger2。首先，我们需要一个Spring Boot实现的

10、RESTful API工程添加Swagger2依赖在pom.xml中加入Swagger2的依赖io.springfoxspringfox-swagger22.2.2springfox-swagger-ui创建Swagger2配置类在Application.java同级创建Swagger2的配置类Swagger2。ConfigurationEnableSwagger2public class Swagger2 Bean public Docket createRestApi（） return new Docket（DocumentationType.SWAGGER_2） .apiInfo（api

11、Info（） .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（ .contact（程序猿DD .version（1.0如上代码所

12、示，通过Configuration注解，让Spring来加载该类配置。再通过EnableSwagger2注解来启用Swagger2。再通过createRestApi函数创建Docket的Bean之后，apiInfo（）用来创建该Api的基本信息（这些基本信息会展现在文档页面中）。select（）函数返回一个ApiSelectorBuilder实例用来控制哪些接口暴露给Swagger来展现，本例采用指定扫描的包路径来定义，Swagger会扫描该包下所有Controller定义的API，并产生文档内容（除了被ApiIgnore指定的请求）。添加文档内容在完成了上述配置后，其实已经可以生产文档内容，

13、但是这样的文档主要针对请求本身，而描述主要来源于函数等命名产生，对用户并不友好，我们通常需要自己增加一些说明来丰富文档内容。如下所示，我们通过ApiOperation注解来给API增加说明、通过ApiImplicitParams、ApiImplicitParam注解来给参数增加说明。RestControllerRequestMapping（value=/users） / 通过这里配置使下面的映射都在/users下，可去除public class UserController static Map users = Collections.synchronizedMap（new HashMap（）

14、; ApiOperation（value=获取用户列表, notes= RequestMapping（value=, method=RequestMethod.GET） public List getUserList（） List r = new ArrayList（users.values（）; return r;创建用户根据User对象创建用户 ApiImplicitParam（name = user, value = 用户详细实体user, required = true, dataType = User RequestMapping（value=, method=RequestMeth

15、od.POST） public String postUser（RequestBody User user） users.put（user.getId（）, user）; return success;获取用户详细信息根据url的id来获取用户详细信息id用户IDLong/id, method=RequestMethod.GET） public User getUser（PathVariable Long id） return users.get（id）;更新用户详细信息根据url的id来指定更新对象，并根据传过来的user信息来更新用户详细信息 ApiImplicitParams（）, ）,

16、 method=RequestMethod.PUT） public String putUser（PathVariable Long id, RequestBody User user） User u = users.get（id）; u.setName（user.getName（）; u.setAge（user.getAge（）; users.put（id, u）;删除用户根据url的id来指定删除对象, method=RequestMethod.DELETE） public String deleteUser（PathVariable Long id） users.remove（id）;完

17、成上述代码添加上，启动Spring Boot程序，访问：http: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文档进行管理，是个不错的选择。链接：个人理解:RESTful API也就是一个可以脱离前端配合而调试接口的方法列表,可输入参数,调用接口,看到返回结果