1、SpringBoot常用

1.1、官方文档

https://docs.spring.io/spring-boot/docs/2.2.4.RELEASE/reference/html/index.html

1.2、搭建SpringBoot程序

使用spring网站:Spring Initializr

1.3 application.yaml

  1. #数据库连接 配置数据源
  2. spring:
  3. datasource:
  4. username: ***
  5. password: ***
  6. url: jdbc:mysql://localhost:3306/mybatis?useUnicode=true&characterEncoding=UTF-8
  7. driver-class-name: com.mysql.cj.jdbc.Driver
  8. #整合mybatis
  9. mybatis:
  10. #使用别名
  11. type-aliases-package: com.qing.pojo
  12. #扫描对应的mapper.xml文件,路径要与resources下的xml文件对应
  13. mapper-locations: classpath:mybatis/mapper/*.xml

1.4 pom.xml

  1. <dependencies>
  2. <dependency>
  3. <groupId>org.springframework.boot</groupId>
  4. <artifactId>spring-boot-starter-web</artifactId>
  5. </dependency>
  6. <dependency>
  7. <groupId>org.springframework.boot</groupId>
  8. <artifactId>spring-boot-starter-test</artifactId>
  9. <scope>test</scope>
  10. </dependency>
  11. <!--thymeleaf-->
  12. <dependency>
  13. <groupId>org.thymeleaf</groupId>
  14. <artifactId>thymeleaf-spring5</artifactId>
  15. </dependency>
  16. <dependency>
  17. <groupId>org.thymeleaf.extras</groupId>
  18. <artifactId>thymeleaf-extras-java8time</artifactId>
  19. </dependency>
  20. </dependencies>

1.5 命名空间

  1. <!--thymeleaf-->
  2. <html lang="en" xmlns:th="http://www.thymeleaf.org">
  3. <!--shiro-->
  4. <!--有提示,但不能使用":" 如 shiro:hasPermission="user:add"-->
  5. <html lang="en" xmlns:shiro="http://www.pollix.at/thymeleaf/shiro">
  6. <!--没有提示,但格式不受限制: 可以使用 shiro:hasPermission="user:add"-->
  7. <html lang="en" xmlns:th="http://www.thymeleaf.org/thymeleaf-extras-shiro">
  8. <!--springsecurity-->
  9. <html lang="en" xmlns:sec="http://www.thymeleaf.org/extras/spring-security">

1.6 mapper.xml

  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
  3. <mapper namespace="com.qing.mapper.admin.AdminUserMapper">
  4. <select id="getById" parameterType="int" resultType="com.xf.pojo.User">
  5. SELECT * FROM t_user WHERE id=#{id}
  6. </select>
  7. </mapper>

2、创建SpringBoot程序方法

2.1 使用spring网站快速搭建

解压压缩包文件,在idea中导入,即可运行一个初始化的SpringBoot程序

2.2 在idea中创建

建议删除package中的后缀,直接使用com.qing


3、SpringBoot原理

3.1 自动配置(重要)

  • SpringBoot启动会加载大量的自动配置类
  • 看我们需要的功能有没有在SpringBoot默认写好的自动配置类当中;
  • 再看这个自动配置类中到底配置了哪些组件;(只要我们要用的组件存在其中,我们就不需要再手动配置了)
  • 给容器中自动配置类添加组件的时候,会从properties类中获取某些属性,只需要在配置文件中指定这些属性的值即可;xxxxAutoConfigurartion:自动配置类;给容器中添加组件

开启debug可以在启动的时候在控制台输出已经生效的配置

  1. debug: true

3.2 pom.xml

  • spring-boot-dependencies:在spring-boot-starter-parent中,且核心依赖在父工程中!
  • 在写或者引入一些SpringBoot依赖时,不需要指定版本,spring-boot-dependencies中封装了所有常用jar包的版本

3.3 启动器

  1. <!--主启动器-->
  2. <dependency>
  3. <groupId>org.springframework.boot</groupId>
  4. <artifactId>spring-boot-starter</artifactId>
  5. </dependency>
  6. <!--web启动器-->
  7. <dependency>
  8. <groupId>org.springframework.boot</groupId>
  9. <artifactId>spring-boot-starter-web</artifactId>
  10. </dependency>
  11. <!--test测试启动器-->
  12. <dependency>
  13. <groupId>org.springframework.boot</groupId>
  14. <artifactId>spring-boot-starter-test</artifactId>
  15. <scope>test</scope>
  16. </dependency>
  • 启动器:SpringBoot的启动场景
  • 如spring-boot-starter-web就会自动帮我们导入web环境的所有依赖
  • springboot将所有的功能场景都封装成了一个个启动器

3.4 主程序

  1. //标注这个类是一个springboot应用
  2. @SpringBootApplication
  3. public class Springboot01HelloApplication {
  4. public static void main(String[] args) {
  5. //启动springboot
  6. SpringApplication.run(Springboot01HelloApplication.class, args);
  7. }
  8. }

3.4.1 SpringBootApplication注解

  1. //1.springboot的配置
  2. @SpringBootConfiguration
  3. //1.1 spring配置类
  4. @Configuration
  5. //1.2 说明这也是一个spring的组件
  6. @Component
  7. //2.自动配置(核心)
  8. @EnableAutoConfiguration
  9. //2.1 自动配置包
  10. @AutoConfigurationPackage
  11. //2.1.1 注册扫描路径到全局变量,提供查询
  12. @Import(AutoConfigurationPackages.Registrar.class)
  13. //2.2 加载配置,完成自动装配
  14. @Import(AutoConfigurationImportSelector.class)
  15. //3.扫描路径 默认扫描启动类所在的当前目录
  16. @ComponentScan
  17. //2.2中的AutoConfigurationImportSelector.class获取所有的配置
  18. List<String> configurations = getCandidateConfigurations(annotationMetadata, attributes);
  1. //getCandidateConfigurations方法 获取候选的配置
  2. protected List<String> getCandidateConfigurations(AnnotationMetadata metadata, AnnotationAttributes attributes) {
  3. List<String> configurations = SpringFactoriesLoader.loadFactoryNames(getSpringFactoriesLoaderFactoryClass(),
  4. getBeanClassLoader());
  5. Assert.notEmpty(configurations, "No auto configuration classes found in META-INF/spring.factories. If you "
  6. + "are using a custom packaging, make sure that file is correct.");
  7. return configurations;
  8. }
  9. //SpringFactoriesLoader.loadFactoryNames方法实现了将META-INF/spring.factories中所有的配置资源加载到配置类中

META-INF/spring.factories 自动配置的核心文件:在spring-boot-test-autoconfigure.jar中

springboot所有的自动配置都在这里

  1. # AutoConfigureCache auto-configuration imports
  2. org.springframework.boot.test.autoconfigure.core.AutoConfigureCache=\
  3. org.springframework.boot.autoconfigure.cache.CacheAutoConfiguration
  4. # AutoConfigureDataCassandra auto-configuration imports
  5. org.springframework.boot.test.autoconfigure.data.cassandra.AutoConfigureDataCassandra=\
  6. org.springframework.boot.autoconfigure.cassandra.CassandraAutoConfiguration,\
  7. org.springframework.boot.autoconfigure.data.cassandra.CassandraDataAutoConfiguration,\
  8. org.springframework.boot.autoconfigure.data.cassandra.CassandraReactiveDataAutoConfiguration,\
  9. org.springframework.boot.autoconfigure.data.cassandra.CassandraReactiveRepositoriesAutoConfiguration,\
  10. org.springframework.boot.autoconfigure.data.cassandra.CassandraRepositoriesAutoConfiguration
  11. ......

3.4.2 流程总结

  • springboot在启动的时候,从类路径下 /META-INF/spring.factories.获取指定的值
  • 将这些自动配置的类导入容器,自动配置就会生效,帮我们进行自动配置
  • 以前我们需要手动配置的东西,现在Springboot帮我们做了
  • 整合javaEE,解决方案和自动配置的东西都在spring-boot-autoconfigure包下
  • 它会把所有需要导入的组件,以类名的方式返回,这些组件就会添加到容器
  • 容器中也会存在XXXXautoConfiguration的文件(@Bean),就是这些类给容器中导入了这个场景所需要的所有组件,并自动配置,@Configuration,JavaConfig
  • 有了自动配置类,免去了我们自己编写配置文件的步骤

3.4.3 SpringApplication类

主要做了四件事:

  • 推断应用的类型是普通的项目还是Web项目
  • 查找并加载所有可用初始化器 , 设置到initializers属性中
  • 找出所有的应用程序监听器,设置到listeners属性中
  • 推断并设置main方法的定义类,找到运行的主类

3.4.4 run方法流程

SpringBoot学习笔记 - 图1


4、SpringBoot配置文件

4.1 配置文件的两种方式

SpringBoot使用一个全局的配置文件 , 配置文件名称是固定的

方式一:application.properties

语法结构 :键值对 key=value 如:

  1. server.port=8081

方式二:application.yml(推荐使用)

语法结构 :key:空格 value 如:

  1. server:
  2. port: 8081

注:port: 这里必须带一个空格

4.2 yaml语法

  1. #yaml对空格的要求及其高
  2. server:
  3. port: 8081
  4. # 普通的key-value
  5. name: 小明
  6. #对象
  7. student:
  8. name: qingfan
  9. age: 3
  10. #行内写法
  11. student1: {name: qingfan,age: 3}
  12. #数组
  13. pets1:
  14. - cat
  15. - dog
  16. - pig
  17. pets2: [cat,dog,pig]

4.3 使用yaml给实体类注入值

yaml中配置属性:

  1. person:
  2. name: qingfan
  3. age: 3
  4. birthday: 2020/1/1
  5. map: {k1: v1,k2: v2}
  6. list:
  7. - code
  8. - music
  9. dog:
  10. name: wangcai
  11. age: 3

person实体类设置:

  1. //@ConfigurationProperties绑定yaml配置中的参数 这里的person对应yaml文件中的person对象名
  2. @ConfigurationProperties(prefix = "person")
  3. public class Person {
  4. private String name;
  5. private String age;
  6. private Date birthday;
  7. private Map<String,Object> map;
  8. private List<Object> list;
  9. private Dog dog;
  10. }

若添加@ConfigurationProperties注解爆红,则在pom.xml配置文件中添加:

  1. <dependency>
  2. <groupId>org.springframework.boot</groupId>
  3. <artifactId>spring-boot-configuration-processor</artifactId>
  4. </dependency>

测试:

  1. @SpringBootTest
  2. class Springboot02ConfigApplicationTests {
  3. @Autowired
  4. Person person;
  5. @Test
  6. void contextLoads() {
  7. System.out.println(person.toString());
  8. //Person(name=qingfan, age=3, birthday=Wed Jan 01 00:00:00 CST 2020, map={k1=v1, k2=v2}, list=[code, music],dog=Dog(name=wangcai,age=3))
  9. }
  10. }

4.4 yaml松散绑定

比如我的yaml中写的last-name,这个和lastName是一样的, - 后面跟着的字母默认是大写的。这就是松散绑定。

4.5 JSR303数据校验

pom.xml中导入依赖:

  1. <dependency>
  2. <groupId>org.springframework.boot</groupId>
  3. <artifactId>spring-boot-starter-validation</artifactId>
  4. </dependency>

在实体类上添加@Validated注解进行数据校验

若在person实体类中name字段上添加@Email()注解,那么就会对name字段进行一个邮箱验证,如果配置的属性不是一个邮箱,则就会报错:

验证格式:

  1. 空检查
  2. @Null 验证对象是否为null
  3. @NotNull 验证对象是否不为null, 无法查检长度为0的字符串
  4. @NotBlank 检查约束字符串是不是Null还有被Trim的长度是否大于0,只对字符串,且会去掉前后空格.
  5. @NotEmpty 检查约束元素是否为NULL或者是EMPTY.
  6. Booelan检查
  7. @AssertTrue 验证 Boolean 对象是否为 true
  8. @AssertFalse 验证 Boolean 对象是否为 false
  9. 长度检查
  10. @Size(min=, max=) 验证对象(Array,Collection,Map,String)长度是否在给定的范围之内
  11. @Length(min=, max=) Validates that the annotated string is between min and max included.
  12. 日期检查
  13. @Past 验证 Date Calendar 对象是否在当前时间之前,验证成立的话被注释的元素一定是一个过去的日期
  14. @Future 验证 Date Calendar 对象是否在当前时间之后 ,验证成立的话被注释的元素一定是一个将来的日期
  15. @Pattern 验证 String 对象是否符合正则表达式的规则,被注释的元素符合制定的正则表达式,regexp:正则表达式 flags: 指定 Pattern.Flag 的数组,表示正则表达式的相关选项。
  16. 数值检查
  17. 建议使用在Stirng,Integer类型,不建议使用在int类型上,因为表单值为“”时无法转换为int,但可以转换为Stirng为”“,Integernull
  18. @Min 验证 Number String 对象是否大等于指定的值
  19. @Max 验证 Number String 对象是否小等于指定的值
  20. @DecimalMax 被标注的值必须不大于约束中指定的最大值. 这个约束的参数是一个通过BigDecimal定义的最大值的字符串表示.小数存在精度
  21. @DecimalMin 被标注的值必须不小于约束中指定的最小值. 这个约束的参数是一个通过BigDecimal定义的最小值的字符串表示.小数存在精度
  22. @Digits 验证 Number String 的构成是否合法
  23. @Digits(integer=,fraction=) 验证字符串是否是符合指定格式的数字,interger指定整数精度,fraction指定小数精度。
  24. @Range(min=, max=) 被指定的元素必须在合适的范围内
  25. @Range(min=10000,max=50000,message=”range.bean.wage”)
  26. @Valid 递归的对关联对象进行校验, 如果关联对象是个集合或者数组,那么对其中的元素进行递归校验,如果是一个map,则对其中的值部分进行校验.(是否进行递归验证)
  27. @CreditCardNumber信用卡验证
  28. @Email 验证是否是邮件地址,如果为null,不进行验证,算通过验证。
  29. @ScriptAssert(lang= ,script=, alias=)
  30. @URL(protocol=,host=, port=,regexp=, flags=)

4.6 配置文件的位置

配置文件的优先级由高到低分别为项目路径下的config/application.yaml>application.yaml>resources/config/application.yaml>resources/application.yaml

优先级1-2-3-4

4.7 yaml多环境切换

---来分隔多个文件,使用profiles的active来选择调用哪个环境

  1. server:
  2. port: 8081
  3. spring:
  4. profiles:
  5. active: dev
  6. #active中不填写则默认启动8081
  7. ---
  8. server:
  9. port: 8082
  10. spring:
  11. profiles: dev
  12. ---
  13. server:
  14. port: 8083
  15. spring:
  16. profiles: test

5、SpringBoot Web开发

5.1 要解决的问题

  • 导入静态资源…
  • 首页
  • jsp,模版引擎Thymeleaf
  • 装配扩展SpringMVC
  • 增删改查
  • 拦截器
  • 国际化

5.2 静态资源

  1. @Override
  2. public void addResourceHandlers(ResourceHandlerRegistry registry) {
  3. if (!this.resourceProperties.isAddMappings()) {
  4. logger.debug("Default resource handling disabled");
  5. return;
  6. }
  7. addResourceHandler(registry, "/webjars/**", "classpath:/META-INF/resources/webjars/");
  8. addResourceHandler(registry, this.mvcProperties.getStaticPathPattern(), (registration) -> {
  9. registration.addResourceLocations(this.resourceProperties.getStaticLocations());
  10. if (this.servletContext != null) {
  11. ServletContextResource resource = new ServletContextResource(this.servletContext, SERVLET_LOCATION);
  12. registration.addResourceLocations(resource);
  13. }
  14. });
  15. }

方式一:通过webjars获得静态资源

  1. addResourceHandler(registry, "/webjars/**", "classpath:/META-INF/resources/webjars/");

访问路径: localhost:8080/wbjars/

方式二:

访问路径:localhost:8080/

  1. private static final String[] CLASSPATH_RESOURCE_LOCATIONS = { "classpath:/META-INF/resources/",
  2. "classpath:/resources/", "classpath:/static/", "classpath:/public/" };

优先级:1-2-3 resources>static>(默认)>public

注意:一但自定义资源路径后,上面的静态资源访问方式都会失效

  1. #配置文件中自定义静态资源路径
  2. spring.mvc.static-path-pattern=/qing
  1. //源码解释
  2. if (!this.resourceProperties.isAddMappings()) {
  3. logger.debug("Default resource handling disabled");
  4. return;
  5. }

5.3 thymeleaf模板引擎

Thymeleaf 官网:https://www.thymeleaf.org/

Thymeleaf 在Github 的主页:https://github.com/thymeleaf/thymeleaf

Spring官方文档找到我们对应的版本:https://docs.spring.io/spring-boot/docs/2.2.5.RELEASE/reference/htmlsingle/#using-boot-starter

thymeleaf中文文档:https://www.docs4dev.com/docs/zh/thymeleaf/3.0/reference/using_thymeleaf.htm

5.3.1 页面跳转

导入thymeleaf依赖:

  1. <dependency>
  2. <groupId>org.thymeleaf</groupId>
  3. <artifactId>thymeleaf-spring5</artifactId>
  4. </dependency>
  5. <dependency>
  6. <groupId>org.thymeleaf.extras</groupId>
  7. <artifactId>thymeleaf-extras-java8time</artifactId>
  8. </dependency>

在templates文件夹下创建html页面

1、Controller下跳转访问页面

  1. @Controller
  2. @RequestMapping("test")
  3. public class TestController {
  4. @RequestMapping("/hello")
  5. public String hello(){
  6. return "test";
  7. }
  8. }
  9. http://localhost:8080/test/hello

2、扩展springmvc实现跳转

  1. @Configuration
  2. public class MyConfig implements WebMvcConfigurer {
  3. @Override
  4. public void addViewControllers(ViewControllerRegistry registry) {
  5. registry.addViewController("/hello").setViewName("test");
  6. }
  7. }

5.3.2 前端取值

html页面引入thymeleaf命名空间

  1. <html lang="en" xmlns:th="http://www.thymeleaf.org">

前端页面获取后台mode中的值

  1. <body>
  2. <h1>卿帆很帅</h1>
  3. <!--所有的html元素都可以被thymeleaf替换接管: th:元素名-->
  4. <h2 th:text="${msg}"></h2>
  5. <div th:text="${msg}"></div>
  6. </body>

5.3.3 其他语法

  1. <!--前端遍历model传来的数组-->
  2. model.addAttribute("array", Arrays.asList("qingfan","chenxinying"));
  3. 方式一:
  4. <h3 th:each="user:${array}" th:text="${user}"></h3>
  5. 方式二:
  6. <h3 th:each="user:${array}">[[${user}]]</h3>
  7. <!--引入静态资源链接-->
  8. <link th:href="@{/css/bootstrap.min.css}" rel="stylesheet">
  9. <!--图片引用-->
  10. <img class="mb-4" th:src="@{/img/bootstrap-solid.svg}">
  11. <!--文本取值-->
  12. <h1 class="..." th:text="#{login.tip}">Please sign in</h1>

5.3.4 解决错误

前端获取model的值时如果出现报错,如下图:

但又能正确得到值时,解决方法是在html的开头添加<!--suppress ALL-->

  1. <!DOCTYPE html>
  2. <!--suppress ALL-->

6、第一个SpringBoot程序

员工系统

6.1 导入静态资源

6.2 实现首页语言国际化

6.2.1 创建i18n文件夹

application.properties配置文件:

  1. #关掉缓存引擎
  2. spring.thymeleaf.cache=false
  3. #国际化配置
  4. spring.messages.basename=i18n.login

6.2.2 编辑中英文对应的properties资源

login.properties:默认语言,一般选择中文,与login_zh_CN.properties文件内容一样

login_zh_CN.properties:

  1. login.btn=登录
  2. login.password=密码
  3. login.remember=记住我
  4. login.tip=请登录
  5. login.username=用户名

login_en_US.properties:

  1. login.btn=Sign in
  2. login.password=Password
  3. login.remember=Remember me
  4. login.tip=Please login in
  5. login.username=Username

6.2.3 自定义解析器

语言解析类MyLocaleResolver:

  1. public class MyLocaleResolver implements LocaleResolver {
  2. //解析请求
  3. @Override
  4. public Locale resolveLocale(HttpServletRequest request) {
  5. String language = request.getParameter("l");
  6. System.out.println(language);
  7. Locale locale = Locale.getDefault();//没有携带国际化参数就走默认
  8. //如果携带了国际化的参数
  9. if (language!=null) {
  10. //分割 国家:地区
  11. String[] split = language.split("_");
  12. locale = new Locale(split[0], split[1]);
  13. }
  14. return locale;
  15. }
  16. @Override
  17. public void setLocale(HttpServletRequest request, HttpServletResponse response, Locale locale) {
  18. }
  19. }

6.3 index首页

  1. <!DOCTYPE html>
  2. <html lang="en_US" xmlns:th="http://www.thymeleaf.org">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
  5. <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
  6. <meta name="description" content="">
  7. <meta name="author" content="">
  8. <title>Signin Template for Bootstrap</title>
  9. <!-- Bootstrap core CSS -->
  10. <link th:href="@{/css/bootstrap.min.css}" rel="stylesheet">
  11. <!-- Custom styles for this template -->
  12. <link th:href="@{/css/signin.css}" rel="stylesheet">
  13. </head>
  14. <body class="text-center">
  15. <form class="form-signin" action="dashboard.html">
  16. <img class="mb-4" th:src="@{/img/bootstrap-solid.svg}" alt="" width="72" height="72">
  17. <h1 class="h3 mb-3 font-weight-normal" th:text="#{login.tip}">Please sign in</h1>
  18. <input type="text" class="form-control" th:placeholder="#{login.username}" required="" autofocus="">
  19. <input type="password" class="form-control" th:placeholder="#{login.password}" required="">
  20. <div class="checkbox mb-3">
  21. <label>
  22. <input type="checkbox" value="remember-me"> [[#{login.remember}]]
  23. </label>
  24. </div>
  25. <button class="btn btn-lg btn-primary btn-block" type="submit">[[#{login.btn}]]</button>
  26. <p class="mt-5 mb-3 text-muted">© 2017-2018</p>
  27. <!--点击链接实现语言切换-->
  28. <a class="btn btn-sm" th:href="@{/index(l='zh_CN')}">中文</a>
  29. <a class="btn btn-sm" th:href="@{/index(l='en_US')}">English</a>
  30. </form>
  31. </body>
  32. </html>

6.4 拦截器

  1. public class MyInterceptor implements HandlerInterceptor {
  2. @Override
  3. public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
  4. //登录拦截器
  5. Object loginUser = request.getSession().getAttribute("loginUser");
  6. //判断session是否为空,即是否已经登录
  7. if (loginUser == null) {
  8. request.setAttribute("msg", "请先登录");
  9. request.getRequestDispatcher("/index").forward(request, response);
  10. return false;
  11. } else {
  12. return true;
  13. }
  14. }
  15. }

6.5 MVC配置

MyMvcConfig类:

  1. @Configuration
  2. public class MyMvcConfig implements WebMvcConfigurer {
  3. //自定义视图解析器
  4. @Override
  5. public void addViewControllers(ViewControllerRegistry registry) {
  6. //action路径走‘/’时 会跳转到index.html页面 如 http://localhost:8080/
  7. registry.addViewController("/").setViewName("index");
  8. //action路径走‘/index’时 会跳转到index.html页面
  9. registry.addViewController("/index").setViewName("index");
  10. registry.addViewController("/mainIndex").setViewName("dashboard");
  11. }
  12. //登录拦截
  13. //放行的页面
  14. private static final String[] CLASSPATH_RESOURCE_LOCATIONS = { "/index","/login","/static/**","/"};
  15. //excludePathPatterns:添加被放行的页面
  16. @Override
  17. public void addInterceptors(InterceptorRegistry registry) {
  18. registry.addInterceptor(new MyInterceptor()).addPathPatterns("/**")
  19. .excludePathPatterns(CLASSPATH_RESOURCE_LOCATIONS);
  20. }
  21. //自定义国际化组件
  22. @Bean
  23. public LocaleResolver localeResolver(){
  24. return new MyLocaleResolver();
  25. }
  26. }

6.6 静态页面抽取公共部分

项目中的需要导航栏都会在多个页面重复存在,这样冗余性很大,可以使用thymeleaf进行页面提取

  1. <!--
  2. 如头部导航栏主体 被抽取的公共部分
  3. 添加 th:fragment="topbar"
  4. -->
  5. <nav class="..." th:fragment="topbar">
  6. ...
  7. </nav>
  8. <!--
  9. 在需要使用公共代码部分的地方添加 th:insert="~{common::topbar}"
  10. -->
  11. <div th:insert="~{common::topbar}"></div>

7、整合JDBC

7.1 选择数据库模块

选择SQL中的JDBC API和数据库驱动MySQL Drive

pom.xml中会自动导入包

  1. <dependency>
  2. <groupId>mysql</groupId>
  3. <artifactId>mysql-connector-java</artifactId>
  4. <scope>runtime</scope>
  5. </dependency>

7.2 配置数据库文件

application.yaml

  1. spring:
  2. datasource:
  3. username: name
  4. password: pwd
  5. #如果出现时区问题,则添加参数 &serverTimezone=UTC dbName:要连接的数据库名
  6. url: jdbc:mysql://localhost:3306/dbName?useUnicode=true&characterEncoding=UTF-8
  7. driver-class-name: com.mysql.cj.jdbc.Driver

7.3 连接测试

检查连接是够成功

  1. @SpringBootTest
  2. class Test {
  3. @Autowired
  4. DataSource dataSource;
  5. @Test
  6. void contextLoads() throws SQLException {
  7. //获取默认数据源 springboot默认是hikari
  8. System.out.println(dataSource.getClass());
  9. // 获取数据库连接 HikariProxyConnection
  10. Connection connection = dataSource.getConnection();
  11. System.out.println(connection);
  12. }
  13. }

7.4 JdbcTemplate

  1. //jdbcTemplate类中封装了所有Mybatis对数据库的操作
  2. //方式一,在sql语句中填写参数
  3. String sql="select * from user";
  4. jdbcTemplate.queryForList(sql); //查询数据,返回list集合
  5. jdbcTemplate.update() //执行sql语句 更新数据
  6. //方式二:使用数组给sql语句中的参数自动填值
  7. String sql2="update user set name=?,pwd=? where id="+id;
  8. Object[] objects=new Object[2];
  9. objects[1]="name";
  10. objects[2]="pwd";
  11. jdbcTemplate.update(sql2,objects);

使用JdbcTemplate不用添加事务,其继承了spring的声明式事务,事务默认开启,且自动回滚

8、Druid数据源

  • Druid 是阿里巴巴开源平台上一个数据库连接池实现,结合了 C3P0、DBCP 等 DB 池的优点,同时加入了日志监控。
  • Druid 可以很好的监控 DB 池连接和 SQL 的执行情况,天生就是针对监控而生的 DB 连接池。
  • Hikari 与 Driud 都是当前 Java Web上最优秀的数据源

8.1 导入xml依赖

  1. <!-- https://mvnrepository.com/artifact/com.alibaba/druid -->
  2. <dependency>
  3. <groupId>com.alibaba</groupId>
  4. <artifactId>druid</artifactId>
  5. <version>1.2.6</version>
  6. </dependency>

8.2 application.yaml文件配置

  1. #springboot默认数据源是hikari 可以使用type选择其他数据源
  2. spring:
  3. datasource:
  4. username: ...
  5. password: ...
  6. url: ...
  7. driver-class-name: com.mysql.cj.jdbc.Driver
  8. #更改为druid数据源
  9. type: com.alibaba.druid.pool.DruidDataSource
  10. #druid其他配置 需自定义配置类
  11. #Spring Boot 默认是不注入这些属性值的,需要自己绑定
  12. #druid 数据源专有配置
  13. initialSize: 5
  14. minIdle: 5
  15. maxActive: 20
  16. maxWait: 60000
  17. timeBetweenEvictionRunsMillis: 60000
  18. minEvictableIdleTimeMillis: 300000
  19. validationQuery: SELECT 1 FROM DUAL
  20. testWhileIdle: true
  21. testOnBorrow: false
  22. testOnReturn: false
  23. poolPreparedStatements: true
  24. #配置监控统计拦截的filters,stat:监控统计、log4j:日志记录、wall:防御sql注入
  25. #如果允许时报错 java.lang.ClassNotFoundException: org.apache.log4j.Priority
  26. #则导入 log4j 依赖即可,Maven 地址:https://mvnrepository.com/artifact/log4j/log4j
  27. filters: stat,wall,log4j
  28. maxPoolPreparedStatementPerConnectionSize: 20
  29. useGlobalDataSourceStat: true
  30. connectionProperties: druid.stat.mergeSql=true;druid.stat.slowSqlMillis=500

8.3 绑定DataSource

给DruidDataSource 绑定全局配置文件中的参数,再添加到容器中,要使8.3中druid其他配置生效,就还需编写一个DruidConfig配置类:

  1. @Configuration
  2. public class DruidConfig {
  3. /*
  4. 将自定义的 Druid数据源添加到容器中,不再让 Spring Boot 自动创建
  5. 绑定全局配置文件中的 druid 数据源属性到 com.alibaba.druid.pool.DruidDataSource从而让它们生效
  6. @ConfigurationProperties(prefix = "spring.datasource"):作用就是将全局配置文件中
  7. 前缀为spring.datasource的属性值注入到 com.alibaba.druid.pool.DruidDataSource 的同名参数中
  8. */
  9. @ConfigurationProperties(prefix = "spring.datasource")
  10. @Bean
  11. public DataSource druidDataSource() {
  12. return new DruidDataSource();
  13. }
  14. }

绑定application.yaml配置文件,使其中的spring配置生效

8.4 配置Druid数据源监控

Druid 数据源具有监控功能,并提供了一个 web 界面方便用户查看,所以设置 Druid 的后台管理页面,比如 登录账号、密码 等;配置后台管理

直接在8.4的DruidConfig类中编写

  1. //内置Servlet容器时,所以没有web.xml文件,只能使用SpringBoot的注册:Servlet方式
  2. @Bean
  3. public ServletRegistrationBean statViewServlet() {
  4. //配置登录页面访问路径 http://localhost:8080/druid/login.html
  5. ServletRegistrationBean bean = new ServletRegistrationBean(new StatViewServlet(), "/druid/*");
  6. // 这些参数可以在StatViewServlet的父类ResourceServlet中找到
  7. Map<String, String> initParams = new HashMap<>();
  8. initParams.put("loginUsername", "admin"); //后台管理界面的登录账号
  9. initParams.put("loginPassword", "123456"); //后台管理界面的登录密码
  10. //后台允许谁可以访问
  11. //initParams.put("allow", "localhost"):表示只有本机可以访问
  12. //initParams.put("allow", ""):为空或者为null时,表示允许所有访问
  13. initParams.put("allow", "");
  14. //deny:Druid后台拒绝谁访问
  15. //initParams.put("qingfan", "192.168.1.20");表示禁止此ip访问
  16. //设置初始化参数
  17. bean.setInitParameters(initParams);
  18. return bean;
  19. }

8.5 配置Druid监控的过滤器

也直接在8.4的DruidConfig类中编写

  1. //WebStatFilter:用于配置Web和Druid数据源之间的管理关联监控统计
  2. @Bean
  3. public FilterRegistrationBean webStatFilter() {
  4. FilterRegistrationBean bean = new FilterRegistrationBean();
  5. bean.setFilter(new WebStatFilter());
  6. //exclusions:设置哪些请求进行过滤排除掉,从而不进行统计
  7. Map<String, String> initParams = new HashMap<>();
  8. initParams.put("exclusions", "*.js,*.css,/druid/*,/jdbc/*");
  9. bean.setInitParameters(initParams);
  10. // "/*" 表示过滤所有请求
  11. bean.setUrlPatterns(Arrays.asList("/*"));
  12. return bean;
  13. }

9、整合Mybatis

9.1 导入依赖

  1. <dependency>
  2. <groupId>org.mybatis.spring.boot</groupId>
  3. <artifactId>mybatis-spring-boot-starter</artifactId>
  4. <version>2.2.0</version>
  5. </dependency>

9.2 Mapper

UserMapper接口:

  1. //Mapper层注解方式:@Mapper
  2. @Mapper
  3. public interface UserMapper {
  4. List<User> queryList();
  5. User queryUserById(Integer id);
  6. int addUser(User user);
  7. int updateUser(User user);
  8. int deleteUserById(Integer id);
  9. }

在resources资源下编写对应的UserMapper.xml配置文件:

9.3 Service

  1. //Service层添加注解的两种方法
  2. /*
  3. 方法一:@Mapper+@Repository
  4. Mapper注解表示这是mybatis的mapper层,接口在编译时会自动生成相应的实现类
  5. Repository注解是将接口的实现类交给spring管理,添加到接口的实现类中,若没有接口的实现类,则可以省略
  6. 方法二:
  7. 在对应的实现类中添加@Service注解,并在注解中表名本类实现的service接口 如:
  8. @Service("EmployeeService")
  9. public class EmployeeServiceImpl implements EmployeeService{...}
  10. */

9.3 配置application.yaml

  1. #数据库连接
  2. spring:
  3. datasource:
  4. username: ***
  5. password: ***
  6. url: jdbc:mysql://localhost:3306/mybatis?useUnicode=true&characterEncoding=UTF-8
  7. driver-class-name: com.mysql.cj.jdbc.Driver
  8. #整合mybatis
  9. mybatis:
  10. #使用别名
  11. type-aliases-package: com.qing.pojo
  12. #扫描对应的mapper.xml文件,路径要与resources下的xml文件对应
  13. mapper-locations: classpath:mybatis/mapper/*.xml

10、SpringSecurity

SpringSecurity有内置的登录、注销界面,我们可以直接使用,且只需要通过简单的配置就能实现用户授权和控制登录等功能

10.1 导入pom依赖

  1. <dependency>
  2. <groupId>org.springframework.boot</groupId>
  3. <artifactId>spring-boot-starter-security</artifactId>
  4. </dependency>

10.2 编写配置类

  1. @EnableWebSecurity
  2. public class SecurityConfig extends WebSecurityConfigurerAdapter {
  3. //授权
  4. @Override
  5. protected void configure(HttpSecurity http) throws Exception {
  6. //首页所有人可以访问,但功能页限制有对应权限的人访问
  7. http.authorizeRequests()
  8. // “/”请求跳转首页 且所有人可以访问
  9. .antMatchers("/").permitAll()
  10. // level1/下的页面只能角色为vip1的可以访问
  11. .antMatchers("/level1/**").hasAnyRole("vip1")
  12. .antMatchers("/level2/**").hasAnyRole("vip2")
  13. .antMatchers("/level3/**").hasAnyRole("vip3");
  14. //没有权限时跳转到登录页面
  15. //loginPage指定登录请求,若不指定则默认走springboot内置的登录页面,loginProcessingUrl与form表单中的路径对应
  16. http.formLogin().loginPage("/toLogin").loginProcessingUrl("/login");
  17. //开启注销功能
  18. //logoutSuccessUrl指定注销后返回的请求,若不指定则默认返回内置登录页面
  19. http.logout().logoutSuccessUrl("/");
  20. /*
  21. 登录时开启记住用户功能 cookie保存 默认2周
  22. http.rememberMe()
  23. 自定义:rememberMeParameter中的参数与前端页面对应 <input type="checkbox" name="remember">
  24. */
  25. http.rememberMe().rememberMeParameter("remember");
  26. }
  27. //认证 springboot2.1可以直接使用
  28. //其他版本使用时需要进行密码加密 new BCryptPasswordEncoder()
  29. @Override
  30. protected void configure(AuthenticationManagerBuilder auth) throws Exception {
  31. auth.inMemoryAuthentication().passwordEncoder(new BCryptPasswordEncoder())
  32. .withUser("qingfan").password(new BCryptPasswordEncoder().encode("123")).roles("vip1")
  33. .and()
  34. .withUser("root").password(new BCryptPasswordEncoder().encode("123")).roles("vip1", "vip2", "vip3")
  35. .and()
  36. .withUser("chen").password(new BCryptPasswordEncoder().encode("123")).roles("vip3");
  37. }
  38. }

11、Shiro

shiro官网http://shiro.apache.org/

11.1 入门案例

创建一个普通的maven项目即可

11.1.1 导入依赖

  1. <dependencies>
  2. <dependency>
  3. <groupId>junit</groupId>
  4. <artifactId>junit</artifactId>
  5. <version>4.9</version>
  6. </dependency>
  7. <dependency>
  8. <groupId>org.slf4j</groupId>
  9. <artifactId>slf4j-simple</artifactId>
  10. <version>1.7.21</version>
  11. </dependency>
  12. <dependency>
  13. <groupId>org.slf4j</groupId>
  14. <artifactId>jcl-over-slf4j</artifactId>
  15. <version>1.7.21</version>
  16. </dependency>
  17. <dependency>
  18. <groupId>commons-logging</groupId>
  19. <artifactId>commons-logging</artifactId>
  20. <version>1.1.3</version>
  21. </dependency>
  22. <dependency>
  23. <groupId>org.apache.shiro</groupId>
  24. <artifactId>shiro-core</artifactId>
  25. <version>1.2.2</version>
  26. </dependency>
  27. </dependencies>

11.1.2 shiro.ini

  1. [users]
  2. root = secret, admin
  3. guest = guest, guest
  4. presidentskroob = 12345, president
  5. darkhelmet = ludicrousspeed, darklord, schwartz
  6. lonestarr = vespa, goodguy, schwartz
  7. [roles]
  8. # 'admin' role has all permissions, indicated by the wildcard '*'
  9. admin = *
  10. # The 'schwartz' role can do anything (*) with any lightsaber:
  11. schwartz = lightsaber:*
  12. # The 'goodguy' role is allowed to 'drive' (action) the winnebago (type) with
  13. # license plate 'eagle5' (instance specific id)
  14. goodguy = winnebago:drive:eagle5

11.1.3 log4j.properties

  1. log4j.rootLogger=INFO, stdout
  2. log4j.appender.stdout=org.apache.log4j.ConsoleAppender
  3. log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
  4. log4j.appender.stdout.layout.ConversionPattern=%d %p [%c] - %m %n
  5. # General Apache libraries
  6. log4j.logger.org.apache=WARN
  7. # Spring
  8. log4j.logger.org.springframework=WARN
  9. # Default Shiro logging
  10. log4j.logger.org.apache.shiro=INFO
  11. # Disable verbose logging
  12. log4j.logger.org.apache.shiro.util.ThreadContext=WARN
  13. log4j.logger.org.apache.shiro.cache.ehcache.EhCache=WARN

11.1.4 测试

  1. public class Tutorial {
  2. private static final transient Logger log = LoggerFactory.getLogger(Tutorial.class);
  3. public static void main(String[] args) {
  4. Factory<SecurityManager> factory = new IniSecurityManagerFactory("classpath:shiro.ini");
  5. SecurityManager securityManager = factory.getInstance();
  6. SecurityUtils.setSecurityManager(securityManager);
  7. //1.获取当前用户对象
  8. Subject currentUser = SecurityUtils.getSubject();
  9. //2.通过当前用户拿到session
  10. Session session = currentUser.getSession();
  11. session.setAttribute("someKey", "aValue");
  12. String value = (String) session.getAttribute("someKey");
  13. if (value.equals("aValue")) {
  14. log.info("Retrieved the correct value! [" + value + "]");
  15. }
  16. // 3.判断当前用户是否被认证
  17. if (!currentUser.isAuthenticated()) {
  18. UsernamePasswordToken token = new UsernamePasswordToken("admin", "12345");
  19. //设置记住我
  20. token.setRememberMe(true);
  21. try {
  22. //执行登录操作
  23. currentUser.login(token);
  24. } catch (UnknownAccountException uae) {
  25. log.info("There is no user with username of " + token.getPrincipal());
  26. } catch (IncorrectCredentialsException ice) {
  27. log.info("Password for account " + token.getPrincipal() + " was incorrect!");
  28. } catch (LockedAccountException lae) {
  29. log.info("The account for username " + token.getPrincipal() + " is locked. " +
  30. "Please contact your administrator to unlock it.");
  31. }
  32. // ... catch more exceptions here (maybe custom ones specific to your application?
  33. catch (AuthenticationException ae) {
  34. //unexpected condition? error?
  35. }
  36. }
  37. //4.获取用户认证信息
  38. log.info("User [" + currentUser.getPrincipal() + "] logged in successfully.");
  39. //5.判断用户角色
  40. if (currentUser.hasRole("schwartz")) {
  41. log.info("May the Schwartz be with you!");
  42. } else {
  43. log.info("Hello, mere mortal.");
  44. }
  45. if (currentUser.isPermitted("lightsaber:wield")) {
  46. log.info("You may use a lightsaber ring. Use it wisely.");
  47. } else {
  48. log.info("Sorry, lightsaber rings are for schwartz masters only.");
  49. }
  50. //a (very powerful) Instance Level permission:
  51. if (currentUser.isPermitted("winnebago:drive:eagle5")) {
  52. log.info("You are permitted to 'drive' the winnebago with license plate (id) 'eagle5'. " +
  53. "Here are the keys - have fun!");
  54. } else {
  55. log.info("Sorry, you aren't allowed to drive the 'eagle5' winnebago!");
  56. }
  57. //6.注销
  58. currentUser.logout();
  59. System.exit(0);
  60. }
  61. }

11.2 boot整合Shiro(Mybatis)

11.2.1 pom.xml

  1. <dependencies>
  2. <!--shiro整合spring-->
  3. <dependency>
  4. <groupId>org.apache.shiro</groupId>
  5. <artifactId>shiro-spring</artifactId>
  6. <version>1.5.3</version>
  7. </dependency>
  8. <!--shiro整合thymeleaf-->
  9. <dependency>
  10. <groupId>com.github.theborakompanioni</groupId>
  11. <artifactId>thymeleaf-extras-shiro</artifactId>
  12. <version>2.0.0</version>
  13. </dependency>
  14. <!--Mysql驱动-->
  15. <dependency>
  16. <groupId>mysql</groupId>
  17. <artifactId>mysql-connector-java</artifactId>
  18. </dependency>
  19. <!--druid数据源-->
  20. <dependency>
  21. <groupId>com.alibaba</groupId>
  22. <artifactId>druid</artifactId>
  23. <version>1.2.6</version>
  24. </dependency>
  25. <!--springboot整合Mybatis-->
  26. <dependency>
  27. <groupId>org.mybatis.spring.boot</groupId>
  28. <artifactId>mybatis-spring-boot-starter</artifactId>
  29. <version>2.2.0</version>
  30. </dependency>
  31. </dependencies>

11.2.2 编写Shiro配置类

  1. @Configuration
  2. public class ShiroConfig {
  3. //ShiroFilterFactoryBean
  4. @Bean
  5. public ShiroFilterFactoryBean filterFactoryBean(@Qualifier("securityManager")DefaultWebSecurityManager defaultWebSecurityManager){
  6. ShiroFilterFactoryBean bean=new ShiroFilterFactoryBean();
  7. //设置安全管理器
  8. bean.setSecurityManager(defaultWebSecurityManager);
  9. //添加shiro内置过滤器
  10. /*
  11. anon:无需认证就可以访问
  12. authc:必须认证才能访问
  13. user:必须有 记住我 功能才能访问
  14. perms:拥有对某个资源权限才能访问
  15. role:拥有某个角色权限才能访问
  16. */
  17. //拦截
  18. Map<String,String> filterMap=new LinkedHashMap<>();
  19. /*
  20. 授权
  21. 参数一:指定控制的页面
  22. 参数二:限制用户进入add页面必须被授权 info.addStringPermission("user-add");
  23. */
  24. filterMap.put("/user/add","perms[user-add]");
  25. filterMap.put("/user/update","perms[user-update]");
  26. // 参数一:控制访问的页面 参数二:权限过滤
  27. filterMap.put("/user/*","authc");
  28. bean.setFilterChainDefinitionMap(filterMap);
  29. //设置登录请求 没有权限时自动跳转
  30. bean.setLoginUrl("/toLogin");
  31. //跳转自定义未授权页面 不指定则走默认404页面
  32. bean.setUnauthorizedUrl("/noAuth");
  33. return bean;
  34. }
  35. //DefaultWebSecurityManager
  36. @Bean(name = "securityManager")
  37. public DefaultWebSecurityManager defaultWebSecurityManager(@Qualifier("userRealm") UserRealm userRealm){
  38. DefaultWebSecurityManager securityManager=new DefaultWebSecurityManager();
  39. securityManager.setRealm(userRealm);
  40. return securityManager;
  41. }
  42. //创建realm对象 需自定义类UserRealm
  43. @Bean(name = "userRealm")
  44. public UserRealm userRealm(){
  45. return new UserRealm();
  46. }
  47. //ShiroDialect:整合shiro与thymeleaf
  48. @Bean
  49. public ShiroDialect getShiroDialect(){
  50. return new ShiroDialect();
  51. }
  52. }

11.2.3 自定义UserRealm类

  1. public class UserRealm extends AuthorizingRealm {
  2. @Autowired
  3. UserService userService;
  4. //授权
  5. @Override
  6. protected AuthorizationInfo doGetAuthorizationInfo(PrincipalCollection principals) {
  7. System.out.println("-----执行授权----");
  8. SimpleAuthorizationInfo info = new SimpleAuthorizationInfo();
  9. //获取当前用户
  10. Subject subject = SecurityUtils.getSubject();
  11. User user = (User) subject.getPrincipal();
  12. //给用户增加权限
  13. info.addStringPermission(user.getPerms());
  14. return info;
  15. }
  16. //用户认证 判断前端输入的用户名密码是否正确
  17. @Override
  18. protected AuthenticationInfo doGetAuthenticationInfo(AuthenticationToken token) throws AuthenticationException {
  19. System.out.println("-----执行认证----");
  20. //取出token中的用户名/密码 前端传回来的
  21. UsernamePasswordToken userToken = (UsernamePasswordToken) token;
  22. //正确的用户名密码,从数据库获取
  23. User user = userService.queryUserByName(userToken.getUsername());
  24. //判断用户名是否正确
  25. if (user == null) {
  26. //直接返回null即可,自动抛出异常:UnknownAccountException
  27. return null;
  28. }
  29. //密码验证 shiro内置封装
  30. return new SimpleAuthenticationInfo(user, user.getPwd(), "");
  31. }
  32. }

11.2.4 Controller控制器

  1. @Controller
  2. public class MyController {
  3. //登录
  4. @RequestMapping("/login")
  5. public String login(String username, String password, Model model) {
  6. //获取当前用户
  7. Subject subject = SecurityUtils.getSubject();
  8. //封装用户的登录数据到token中
  9. UsernamePasswordToken token = new UsernamePasswordToken(username, password);
  10. try {
  11. //执行登录操作
  12. subject.login(token);
  13. //登录成功 返回首页
  14. return "index";
  15. } catch (UnknownAccountException|IncorrectCredentialsException exception) {
  16. //登录失败,前端返回提示
  17. model.addAttribute("msg", "用户名或密码错误");
  18. return "login";
  19. }
  20. }
  21. //注销
  22. @RequestMapping("/logout")
  23. public String logout(){
  24. Subject currentUser = SecurityUtils.getSubject();
  25. currentUser.logout();
  26. return "redirect:/toLogin";
  27. }
  28. }

11.3 Shiro常用标签

  1. <!--验证当前用户是否拥有指定权限。 -->
  2. <a shiro:hasPermission="user:add" href="#" >add用户</a><!-- 拥有权限 -->
  3. <!--与hasPermission标签逻辑相反,当前用户没有制定权限时,验证通过。-->
  4. <p shiro:lacksPermission="user:del"> 没有权限 </p>
  5. <!--验证当前用户是否拥有以下所有权限。-->
  6. <p shiro:hasAllPermissions="user:view, user:add"> 权限与判断 </p>
  7. <!--验证当前用户是否拥有以下任意一个权限。-->
  8. <p shiro:hasAnyPermissions="user:view, user:del"> 权限或判断 </p>
  9. <!--验证当前用户是否属于该角色。-->
  10. <a shiro:hasRole="admin" href="#">拥有该角色</a>
  11. <!--与hasRole标签逻辑相反,当用户不属于该角色时验证通过。-->
  12. <p shiro:lacksRole="developer"> 没有该角色 </p>
  13. <!--验证当前用户是否属于以下所有角色。-->
  14. <p shiro:hasAllRoles="developer, admin"> 角色与判断 </p>
  15. <!--验证当前用户是否属于以下任意一个角色。-->
  16. <p shiro:hasAnyRoles="admin, vip, developer"> 角色或判断 </p>
  17. <!--验证当前用户是否为“访客”,即未认证(包含未记住)的用户。-->
  18. <p shiro:guest="">访客 未认证</a></p>
  19. <!--认证通过或已记住的用户-->
  20. <p shiro:user=""> 认证通过或已记住的用户 </p>
  21. <!--已认证通过的用户。不包含已记住的用户,这是与user标签的区别所在。-->
  22. <p shiro:authenticated=""> <span shiro:principal=""></span> </p>
  23. <!--输出当前用户信息,通常为登录帐号信息-->
  24. <p> <shiro:principal/> </p>
  25. <!--未认证通过用户,与authenticated标签相对应。-->
  26. <!--与guest标签的区别是,该标签包含已记住用户。-->
  27. <p shiro:notAuthenticated=""> 未认证通过用户 </p>

12、Swagger

  • 号称世界上最流行的API框架
  • Restful Api 文档在线自动生成器 => API 文档 与API 定义同步更新
  • 直接运行,在线测试API
  • 支持多种语言 (如:Java,PHP等)

12.1 常用

官网:https://swagger.io/

依赖:

  1. <dependency>
  2. <groupId>io.springfox</groupId>
  3. <artifactId>springfox-swagger2</artifactId>
  4. <version>2.9.2</version>
  5. </dependency>
  6. <dependency>
  7. <groupId>io.springfox</groupId>
  8. <artifactId>springfox-swagger-ui</artifactId>
  9. <version>2.9.2</version>
  10. </dependency>

12.2 基本配置

导入pom依赖,编写SwaggerConfig配置类

  1. @Configuration
  2. //开启swagger2
  3. @EnableSwagger2
  4. public class SwaggerConfig {
  5. @Bean
  6. //Swagger实例Bean是Docket,所以通过配置Docket实例来配置Swaggger
  7. public Docket docket(){
  8. return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo());
  9. }
  10. private ApiInfo apiInfo(){
  11. //作者信息
  12. Contact contact = new Contact("卿帆", "https://cn.bing.com", "2259479766@qq.com");
  13. //配置文档信息
  14. return new ApiInfo(
  15. "卿帆的Swagger文档", //标题
  16. "11111111", //描述
  17. "1.0", //版本号
  18. "https://cn.bing.com:", // 组织链接
  19. contact, // 作者信息
  20. "Apache 2.0", // 许可
  21. "http://www.apache.org/licenses/LICENSE-2.0", // 许可连接
  22. new ArrayList<VendorExtension>()); // 扩展
  23. }
  24. }

访问:http://localhost:8080/swagger-ui.html

11.3 配置扫描接口及开关

  1. @Bean
  2. public Docket docket() {
  3. //设置要显示Swagger的生产环境 项目中可能会有多套环境
  4. //配置当项目处于test、dev环境时显示swagger,处于prod时不显示
  5. Profiles profiles=Profiles.of("dev","test");
  6. //判断是否在自己设定的环境中
  7. boolean flag=environment.acceptsProfiles(profiles);
  8. /*
  9. enable:配置是否启用Swagger,默认为true,如果是false,在浏览器将无法访问
  10. select:通过.select()方法,去配置扫描接口,RequestHandlerSelectors配置如何扫描接口
  11. basePackage:配置要扫描的包
  12. paths: 配置扫描请求路径,ant():指定请求扫描 any():任何请求都扫描 none():任何请求都不扫描
  13. groupName:配置分组 默认:Default
  14. */
  15. return new Docket(DocumentationType.SWAGGER_2)
  16. .apiInfo(apiInfo())
  17. .enable(flag)
  18. .select()
  19. .apis(RequestHandlerSelectors.basePackage("com.qing.controller"))
  20. .paths(PathSelectors..any())
  21. .build
  22. .groupName("qing");
  23. }

多套配置环境:

11.4 接口注释

User实体类:

  1. //@ApiModel给实体类添加注释,@ApiModelProperty给属性添加注释
  2. @ApiModel("用户实体类")
  3. public class User {
  4. @ApiModelProperty("用户名")
  5. private String name;
  6. @ApiModelProperty("密码")
  7. private String pwd;
  8. //set、get方法
  9. }

Controller:

  1. @RestController
  2. public class HelloController {
  3. //@ApiOperation不能放在类上,只能作用在方法接口上,描述方法
  4. @ApiOperation("这个方法返回Hello")
  5. @GetMapping(value = "/hello")
  6. public String hello(@ApiParam("用户名") String username){
  7. return "hello";
  8. }
  9. //只要在方法中,返回值中存在实体类,就会被swagger扫描
  10. @PostMapping(value = "/user")
  11. public User User(){
  12. return new User();
  13. }
  14. }

Swagger页面显示:


13、任务

13.1 异步任务

  1. //开启异步注解 在springboot主程序上添加
  2. @EnableAsync
  3. public class Springboot09TaskApplication {}

13.2 发送邮件

13.1.1 导入依赖

  1. <!--邮件-->
  2. <dependency>
  3. <groupId>org.springframework.boot</groupId>
  4. <artifactId>spring-boot-starter-mail</artifactId>
  5. </dependency>

13.1.2 application.properties

  1. spring.mail.username=2259479766@qq.com
  2. spring.mail.password=xyqyfuunjkcsdiae
  3. spring.mail.host=smtp.qq.com
  4. #设置加密
  5. spring.mail.properties.mail.smtp.ssl.enable=true

13.1.3 简单测试

  1. @SpringBootTest
  2. class Springboot09TaskApplicationTests {
  3. @Autowired
  4. JavaMailSenderImpl javaMailSender;
  5. @Test
  6. void Test() {
  7. SimpleMailMessage mailMessage = new SimpleMailMessage();
  8. //标题
  9. mailMessage.setSubject("第一封信");
  10. //内容
  11. mailMessage.setText("hello,qing");
  12. //收件人
  13. mailMessage.setTo("2259479766@qq.com");
  14. //发件人
  15. mailMessage.setFrom("2259479766@qq.com");
  16. javaMailSender.send(mailMessage);
  17. }
  18. }

13.1.4 复杂邮件

  1. void Test2() throws MessagingException {
  2. //一个复杂的邮件
  3. MimeMessage mailMessage=javaMailSender.createMimeMessage();
  4. //组装
  5. MimeMessageHelper helper = new MimeMessageHelper(mailMessage,true);
  6. helper.setSubject("第二封邮件");
  7. //true:设置为html格式
  8. helper.setText("<p>1111111111</p>",true);
  9. //附件
  10. helper.addAttachment("1.jpg",new File(""));
  11. //收件人
  12. helper.setTo("2259479766@qq.com");
  13. //发件人
  14. helper.setFrom("2259479766@qq.com");
  15. }

13.3 定时任务

  1. //开启定时功能 在springboot主程序上添加
  2. @EnableScheduling
  3. public class Springboot09TaskApplication {}
  1. //cron表达式
  2. //秒 分 时 日 月 周几
  3. @Scheduled(cron = "* 5 12 2 8 *")
  4. public void Test() {
  5. System.out.println("hello");
  6. }

14、登录验证码实现

SpringBoot结合DefaultKaptcha实现验证码的功能

14.1 自定义KaptchaConfig配置类

  1. import com.google.code.kaptcha.impl.DefaultKaptcha;
  2. import org.springframework.context.annotation.Bean;
  3. import com.google.code.kaptcha.util.Config;
  4. import org.springframework.stereotype.Component;
  5. import java.util.Properties;
  6. @Component
  7. public class KaptchaConfig {
  8. @Bean
  9. public DefaultKaptcha getDefaultKaptcha(){
  10. // 创建DefaultKaptcha对象
  11. DefaultKaptcha defaultKaptcha = new DefaultKaptcha();
  12. Properties properties = new Properties();
  13. properties.put("kaptcha.border", "no");
  14. properties.put("kaptcha.textproducer.font.color", "72,118,255");
  15. properties.put("kaptcha.image.width", "160");
  16. properties.put("kaptcha.image.height", "40");
  17. properties.put("kaptcha.textproducer.font.size", "30");
  18. properties.put("kaptcha.session.key", "verifyCode");
  19. properties.put("kaptcha.textproducer.char.space", "5");
  20. Config config = new Config(properties);
  21. defaultKaptcha.setConfig(config);
  22. return defaultKaptcha;
  23. }
  24. }

14.2 编写VerifyCodeController控制器

  1. @Controller
  2. @RequestMapping("/verify")
  3. public class VerifyCodeController {
  4. @Autowired
  5. private DefaultKaptcha captchaProducer;//定义DefaultKaptcha对象
  6. @GetMapping("/kaptcha")
  7. public void defaultKaptcha(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse) throws Exception {
  8. // 创建字节数组用于存放图片信息
  9. byte[] captchaOutputStream = null;
  10. // 创建字节数组用于存放图片信息
  11. ByteArrayOutputStream imgOutputStream = new ByteArrayOutputStream();
  12. try {
  13. //生产验证码字符串并保存到session中
  14. // 通过DefaultKaptcha获得随机验证码
  15. String verifyCode = captchaProducer.createText();
  16. // 将生成的验证码存放在session中
  17. httpServletRequest.getSession().setAttribute("verifyCode", verifyCode);
  18. // 使用生成的验证码字符串,完成图片的生成
  19. BufferedImage challenge = captchaProducer.createImage(verifyCode);
  20. // 将图片写入到流中
  21. ImageIO.write(challenge, "jpg", imgOutputStream);
  22. } catch (IllegalArgumentException e) {
  23. //将图片写入到输入流出现错误
  24. httpServletResponse.sendError(HttpServletResponse.SC_NOT_FOUND);
  25. return;
  26. }
  27. // 使用HttpServletResponse将图片写入到浏览器中
  28. captchaOutputStream = imgOutputStream.toByteArray();
  29. // 通过response设定响应请求类型
  30. // no-store用于防止重要的信息被无意的发布。在请求消息中发送将使得请求和响应消息都不使用缓存。
  31. httpServletResponse.setHeader("Cache-Control", "no-store");
  32. // no-cache指示请求或响应消息不能缓存
  33. httpServletResponse.setHeader("Pragma", "no-cache");
  34. /* expires是response的一个属性,它可以设置页面在浏览器的缓存里保存的时间 ,超过设定的时间后就过期 。
  35. 过期后再次浏览该页面就需要重新请求服务器发送页面数据,
  36. 如果在规定的时间内再次访问次页面 就不需从服务器传送 直接从缓存中读取。
  37. */
  38. httpServletResponse.setDateHeader("Expires", 0);
  39. // servlet接受request请求后接受图片形式的响应
  40. httpServletResponse.setContentType("image/jpeg");
  41. //通过response获得输出流
  42. ServletOutputStream responseOutputStream = httpServletResponse.getOutputStream();
  43. responseOutputStream.write(captchaOutputStream);
  44. responseOutputStream.flush();
  45. responseOutputStream.close();
  46. }
  47. }

14.3 前端随即获取验证码

  1. <div class="col-6">
  2. <img alt="单击图片刷新!" class="pointer" th:src="@{/verify/kaptcha}"
  3. onclick="this.src='/verify/kaptcha?d='+new Date()*1">
  4. </div>

这里onclick路径中加一个是为了防止点击更换验证码前后因为路径一样验证码没有变化的问题。