/spring-boot-example-kotlin

Primary LanguageJavaApache License 2.0Apache-2.0

Spring Boot 的一些使用记录

Java 版

Filter

components 包下

当 Filter 无序时使用 @ServletComponentScan 扫描即可。

当 Filter 需要排序时，见 WebConfig 中的 FilterRegistrationBean 配置， 此时 @WebFilter 不再生效， name 和 urlPatterns 都在 FilterRegistrationBean 里配置，order 越小越靠前。

Interceptor

Listener

Servlet

ExceptionHandler

Scheduled

普通类调用 Spring bean 对象。

注意使用时以下两种方式任选其一：

  1. 此类加上 @Component 注解并需要放到可以被被扫描的目录。
  2. 在任意 @Configuration 定义 @Bean public SpringUtil springUtil(){return new SpringUtil();}
  3. 在任意 @Configuration 类上注解 @Import(value={SpringUtil.class})

Docker

首先，如果你还没有Docker请先下载它。可以跟随这个指南来获取 Docker: https://docs.docker.com/installation/，然后在开发机上安装并运行。

当然你也需要安装Docker Compose，这个指南将会帮到你: https://docs.docker.com/compose/install/。

Docker MySQL

# MySQL 8
docker pull mysql:8.0.1
mkdir -p docker/mysql/8.0
cd mysql
docker run -p 3306:3306 --name jefferlau-mysql-8 -v $PWD/8.0:/var/lib/mysql -e MYSQL_ROOT_PASSWORD=12345678 -d mysql:8.0.1
# MySQL 5.7
docker pull mysql:5.7.18
mkdir -p docker/mysql/5.7
cd mysql
docker run -p 3306:3306 --name jefferlau-mysql-5.7 -v $PWD/5.7:/var/lib/mysql -e MYSQL_ROOT_PASSWORD=12345678 -d mysql:5.7.18

-v 是将宿主机目录挂载到 Docker 容器的指定目录 $PWD 是命令执行当前目录

使用客户端工具连接 localhost:3306 端口，使用脚本 spring-boot-example-dao/src/main/resources/schema.sql 和 data.sql 初始化数据库。

项目

Dockerfile

mkdir -p src/main/docker
tee src/main/docker/Dockerfile <<-'EOF'
FROM java:8
MAINTAINER Jeffer Lau
VOLUME /tmp
ADD spring-boot-example-web-package.jar app.jar
COPY application.yml application.yml
COPY app.conf app.conf
RUN sh -c 'touch /app.jar'
RUN sh -c 'touch /application.yml'
RUN sh -c 'touch /app.conf'
ENV JAVA_OPTS="-Djava.security.egd=file:/dev/./urandom"
ENTRYPOINT [ "sh", "-c", "/app.jar" ]
EOF

配置数据库连接

详情见如下两个文件

  • docker/docker-compose.yml
  • web 和 sheduler 的 src/main/docker/application.yml

docker-compose.yml 的 external_links 节点，参数格式跟 links 类似，使用服务名称（同时作为别名）或服务名称:服务别名 （SERVICE:ALIAS） 格式都可以。

application.yml 里 datasource.url 的 hostname 就是上述的服务别名。

Docker 启停操作

Docker 集群启停操作(建议)

mvn clean package -DskipTests
cd docker && docker-compose up
# 停止命令：
# docker-compose up
# docker-compose 操作详见 docker-compose help

单个项目编译及启停操作(不建议)

mvn clean package docker:build -DskipTests 

docker run -p 8081:8081 -d --name spring-boot-example-web -t jefferlau/spring-boot-example-web
docker ps
docker stop spring-boot-example-web
docker start spring-boot-example-web

docker exec -it spring-boot-example-web /bin/bash

访问 WEB 项目

浏览器打开链接地址： [http://localhost:8081/swagger-ui.html] 查看文档界面，在 user-controller -> GET /userInfo 接口，调用验证应用是否正常连接数据库。

Swagger

常用注解

  • @Api：用在类上，说明该类的作用

    • value：url 的路径值
    • tags：如果设置这个值、value 的值会被覆盖
    • description：对 api 资源的描述
    • basePath：基本路径可以不配置
    • position：如果配置多个 Api 想改变显示的顺序位置
    • produces：For example, "application/json, application/xml"
    • consumes：For example, "application/json, application/xml"
    • protocols：Possible values: http, https, ws, wss.
    • authorizations：高级特性认证时配置
    • hidden：配置为 true 将在文档中隐藏

  • @ApiOperation：用在方法上，说明方法的作用

    • value：url的路径值
    • tags：如果设置这个值、value 的值会被覆盖
    • notes：对api资源的描述
    • response：返回的对象
    • responseContainer：这些对象是有效的 "List", "Set" or "Map".，其他无效
    • responseReference：可以不配置
    • httpMethod：可以接受 "GET", "HEAD", "POST", "PUT", "DELETE", "OPTIONS" and "PATCH"
    • position：如果配置多个 Api 想改变显示的顺序位置
    • produces：For example, "application/json, application/xml"
    • consumes：For example, "application/json, application/xml"
    • protocols：值 http, https, ws, wss.
    • authorizations：高级特性认证时配置
    • hidden：配置为 true 将在文档中隐藏
    • code：http的状态码 默认 200
    • extensions：扩展属性

  • @ApiParam 请求属性

    • name：属性名称
    • value：属性值
    • defaultValue：默认属性值
    • allowableValues：可以不配置
    • required：是否属性必填
    • access：不过多描述
    • allowMultiple：默认为 false
    • hidden：隐藏该属性
    • example：举例子
    • examples

  • @ApiImplicitParams：用在方法上包含一组参数说明

  • @ApiImplicitParam：用在@ApiImplicitParams注解中，指定一个请求参数的各个方面

    • paramType：参数放在哪个地方
      • header --> 请求参数的获取：@RequestHeader
      • query --> 请求参数的获取：@RequestParam 或者 @ModelAttribute
      • path（用于 RESTful 接口）--> 请求参数的获取：@PathVariable
      • body
      • form
    • name：参数名
    • dataType：参数类型
    • required：参数是否必须传
    • value：参数的意思
    • defaultValue：参数的默认值

  • @ApiResponses：用于表示一组响应集

    • value：多个@ApiResponse配置

  • @ApiResponse：用在@ApiResponses中，一般用于表达一个错误的响应信息

    • code：http的状态码
    • message：描述
    • response：默认响应类 Void
    • reference：参考@ApiOperation中配置
    • responseHeaders：参考@ResponseHeader属性配置说明
    • responseContainer：参考@ApiOperation中配置

  • @ResponseHeader

    • name：响应头名称
    • description：头描述
    • response：默认响应类 Void
    • responseContainer：参考@ApiOperation中配置

  • @ApiModel：描述一个 Model 的信息（这种一般用在 POST 创建的时候，使用@RequestBody这样的场景，请求参数无法使用@ApiImplicitParam注解进行描述的时候）

    • value：默认为类的名称
    • description：对该类的描述
    • parent：可以不配置
    • discriminator：可以不配置
    • subTypes：可以不配置
    • reference：引用配置可以不考虑

  • @ApiModelProperty：描述一个 Model 的属性

    • value：属性描述
    • name：如果配置覆盖属性名称
    • allowableValues：参考@ApiParam配置项项
    • access：可以不配置
    • notes：没有使用
    • dataType：数据类型
    • required：参考@ApiParam配置项项
    • position：参考@ApiOperation配置项
    • hidden：参考@ApiOperation配置项
    • example：参考@ApiParam配置项项
    • readOnly
    • reference：参考@ApiParam配置项项

  • 注解说明文档

Alibaba Druid 参考文件

OAuth

curl -u sample-client:secret http://localhost:8084/oauth/token -d "username=admin&password=123456&scope=write&grant_type=password"
curl http://localhost:8080/userinfo/93201214-3b98-11e7-8b90-efc0f68ee6d7 -H "Authorization: bearer 7e7b7ced-3747-43a2-8134-c7e6b87c6451"