8.swagger插件-在线接口文档
小知识点:
Integer转List类型
List<Long> bookIds = Stream.of(ids).map(id -> Long.valueOf(id)).collect(Collectors.toList());
借助工具类ObjectUtils,判断list为空
ObjectUtils.isEmpty(books);
url传list型参数
http://localhost:8089/bookListPage?pageNo=1&pageSize=10&ids=1&ids=2&ids=3&ids=4
这样即可,接受多个参数时,Integer... ids要放在最后
public RequestResult<PageSupport<Books>> bookListUsePage(@ApiParam(required = true, name = "pageNo",
value = "当前页码", defaultValue = "1") @RequestParam Integer pageNo,
@RequestParam Integer pageSize,
@RequestParam Integer... ids) {
日期格式
@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss",timezone = "GTM+8")
Swagger在线接口文档
依赖:
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.9.2</version>
</dependency>
<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.9.2</version>
</dependency>
开启swagger注解:
@EnableSwagger2
如何访问:
http://localhost:8089/swagger-ui.html
swagger各种注解:
@Api
@ApiOperation
@ApiParam
@ApiModel
@ApiImplicitParams/@ApiImplicitParam
@ApiResponses/@ApiResponse
// 此注解是添加在controller类,说明当前接口的功能和版本,比如:xxxx入口,版本号为:1.0.xxxx
@Api(tags = "图书管理操作入口")
// 此注解一般都是写在控制器的某个方法上,用于描述当前方法的功能,value-功能概要描述,notes-详细描述
@ApiOperation(value = "根据多个图书编号,查询图书列表", notes = "支持分页")
// 此注解一般都是写在控制器的方法的某个参数前面
@ApiParam(required = true, name = "pageNo",value = "当前页码", defaultValue = "1")@RequestParam Integer pageNo
// 实体注解,描述实体类
@ApiModel(value = "图书实体类", description = "对应bookdb中的books表")
//只能加在实体属性上,用于描述实体中的属性含义
@ApiModelProperty(value = "图书编号")
// 此注解一般都是写在控制器的某个方法上,用于说明当前方法的参数含义
@ApiImplicitParams({
@ApiImplicitParam(name = "pageSize", required = true, defaultValue = "3", value = "页面容量"),
@ApiImplicitParam(name = "ids", required = true, value = "图书id集合")
})
// 此注解一般都是写在控制器的某个方法上,用于说明当前方法可能返回的异常码和异常说明
@ApiResponses({
@ApiResponse(code = 9999, message = "系统异常")
})
Swagger(by:xiaoymin)
更酷更炫更简介
依赖:
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>swagger-bootstrap-ui</artifactId>
<version>1.9.3</version>
</dependency>
开启swagger注解:
@EnableSwaggerBootstrapUI
如何访问:
http://localhost:8089/doc.html
非空校验
@NotNull(message = "书名不能为空")
@Valid
然后加一个BindingResult bindingResult参数,bindingResult返回boolean值,识别校验是否正确
java的(PO,VO,TO,BO,DAO,POJO)解释
PO:
全称是persistant object持久对象
最形象的理解就是一个PO就是数据库中的一条记录。
好处是可以把一条记录作为一个对象处理,可以方便的转为其它对象。
BO:
全称是business object:业务对象
主要作用是把业务逻辑封装为一个对象。这个对象可以包括一个或多个其它的对象。
比如一个简历,有教育经历、工作经历、社会关系等等。
我们可以把教育经历对应一个PO,工作经历对应一个PO,社会关系对应一个PO。
建立一个对应简历的BO对象处理简历,每个BO包含这些PO。
这样处理业务逻辑时,我们就可以针对BO去处理。
VO :
value object值对象
ViewObject表现层对象
主要对应界面显示的数据对象。对于一个WEB页面,或者SWT、SWING的一个界面,用一个VO对象对应整个界面的值。
DTO :
Data Transfer Object数据传输对象
主要用于远程调用等需要大量传输对象的地方。
比如我们一张表有100个字段,那么对应的PO就有100个属性。
但是我们界面上只要显示10个字段,
客户端用WEB service来获取数据,没有必要把整个PO对象传递到客户端,
这时我们就可以用只有这10个属性的DTO来传递结果到客户端,这样也不会暴露服务端表结构.到达客户端以后,如果用这个对象来对应界面显示,那此时它的身份就转为VO
POJO :
plain ordinary java object 简单java对象
个人感觉POJO是最常见最多变的对象,是一个中间对象,也是我们最常打交道的对象。
一个POJO持久化以后就是PO
直接用它传递、传递过程中就是DTO
直接用来对应表示层就是VO
DAO:
data access object数据访问对象
这个大家最熟悉,和上面几个O区别最大,基本没有互相转化的可能性和必要.
主要用来封装对数据库的访问。通过它可以把POJO持久化为PO,用PO组装出来VO、DTO
简化版:
- VO:值对象、视图对象
- PO:持久对象
- QO:查询对象
- DAO:数据访问对象
- DTO:数据传输对象
借助工具类,实现实体值的转换
(手动进行转换也可以,但是不方便(必须入参实体每个get出来,一次set到操作实体))
BeanUtils.copyProperties(booksForm, books);
阿里数据源
依赖:
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>druid</artifactId>
<version>1.1.10</version>
</dependency>
yml配置:
# 端口
server:
port: 8089
# 数据源其他配置
spring:
datasource:
driver-class-name: com.mysql.jdbc.Driver
url: jdbc:mysql://localhost:3306/bookdb?serverTimezone=GMT%2B8&useUnicode=true&characterEncoding=UTF-8
username: root
password: root
type: com.alibaba.druid.pool.DruidDataSource
# 初始化时建立物理连接的个数。初始化发生在显示调用init方法,或者第一次getConnection时
initialSize: 5
# 最小连接池数量
minIdle: 5
# 最大连接池数量
maxActive: 20
# 获取连接时最大等待时间,单位毫秒。
maxWait: 60000
# 配置间隔多久才进行一次检测,检测需要关闭的空闲连接,单位是毫秒
timeBetweenEvictionRunsMillis: 60000
# 配置一个连接在池中最小生存的时间,单位是毫秒
minEvictableIdleTimeMillis: 300000
# 用来检测连接是否有效的sql,要求是一个查询语句。如果validationQuery为null,testOnBorrow、testOnReturn、testWhileIdle都不会其作用。
validationQuery: SELECT 1 FROM DUAL
# 建议配置为true,不影响性能,并且保证安全性。申请连接的时候检测,如果空闲时间大于timeBetweenEvictionRunsMillis,执行validationQuery检测连接是否有效
testWhileIdle: true
# 申请连接时执行validationQuery检测连接是否有效,做了这个配置会降低性能。
testOnBorrow: false
# 归还连接时执行validationQuery检测连接是否有效,做了这个配置会降低性能
testOnReturn: false
# 是否缓存preparedStatement,也就是PSCache。PSCache对支持游标的数据库性能提升巨大,比如说oracle。在mysql下建议关闭
poolPreparedStatements: false
maxPoolPreparedStatementPerConnectionSize: 20
# 合并多个DruidDataSource的监控数据
useGlobalDataSourceStat: true
# 配置监控统计拦截的filters,去掉后监控界面sql无法统计
# 属性性类型是字符串,通过别名的方式配置扩展插件,常用的插件有:监控统计用的filter:stat日志用的filter:log4j防御sql注入的filter:wall
filters: stat,wall,log4j
# 通过connectProperties属性来打开mergeSql功能;慢SQL记录
connectionProperties: druid.stat.mergeSql=true;druid.stat.slowSqlMillis=500
# 数据库配置
mybatis:
configuration:
map-underscore-to-camel-case: true
mapper-locations: mybatis/mapper/*.xml
Druid数据源配置类:
package com.lcywings.sbt.config;
import com.alibaba.druid.pool.DruidDataSource;
import com.alibaba.druid.support.http.StatViewServlet;
import com.alibaba.druid.support.http.WebStatFilter;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.boot.web.servlet.ServletRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import javax.sql.DataSource;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;
/**
* Created on 2021/7/28.
* <p>
* Author : Lcywings
* <p>
* Description : Druid数据源配置类
*/
@Configuration
public class Druid {
@Bean
@ConfigurationProperties(prefix = "spring.datasource")
public DataSource dataSource() {
return new DruidDataSource();
}
/**
* 配置druid数据库的监控后台
*/
@Bean
public ServletRegistrationBean statViewServlet() {
ServletRegistrationBean bean = new ServletRegistrationBean(new StatViewServlet(), "/druid/*");
// 初始化参数
Map<String, String> initParams = new HashMap<>();
initParams.put("loginUsername", "admin");
initParams.put("loginPassword", "admin");
// 是否允许访问
initParams.put("allow", "");
bean.setInitParameters(initParams);
return bean;
}
/**
* 配置web监控的过滤器
*/
@Bean
public FilterRegistrationBean webStatFilter() {
FilterRegistrationBean bean = new FilterRegistrationBean();
bean.setFilter(new WebStatFilter());
// 初始化参数
Map<String, String> initParams = new HashMap<>();
// 排除过滤,静态文件等
initParams.put("exclusions", "*.css,*.js,/druid/*");
bean.setInitParameters(initParams);
bean.setUrlPatterns(Arrays.asList("/*"));
return bean;
}
}
后台管理系统访问:
Q.E.D.