Spring实战学习

Java Spring
程序设计
发布日期:   2020-08-13
更新日期:   2022-10-31
文章字数:   3.2k
阅读时长:   12 分
阅读次数:  

前言

本文记录学习《Spring实战》(第五版)中的知识点，并将一些开发项目中遇到的相关经验与理解记录在这里。

唯一不变的就是变化 ----希腊哲学家 赫拉克利特

第一部分 Spring基础

Spring的核心提供了一个叫做Spring上下文(Spring application context)的容器，其创建和管理应用组件(bean)。将bean组装在一起的行为是通过基于依赖注入(dependency injection,DI)的模式实现。组件不会创建它所依赖的组件并管理它们的生命周期，使用依赖注入的应用依赖于单独的实体（容器）来创建和维护所有的组件，并将其注入到它们所需的bean中。

以往，使用一个或多个xml文件指导Spring上下文将bean装配在一起。现在推荐使用基于java的配置。@Configuration注释告知Spring这是一个配置类，为Spring应用提供上下文。使用@Bean注释标注，表明方法返回的对象会以bean的形式添加到Spring的上下文。(默认这些bean对应的bean ID与定义它们的方法名称相同)。

基于java的配置相较于xml有更强的类型安全性和更好的重构能力。

只有当Spring不能进行自动配置时，才需要显示配置。

Spring Initializr是一个能够生成Spring Boot项目的REST API。

Spring项目的目录结构：

  • mvnw和mvnw.cmd：Maven包装器(wrapper)脚本。即使机器上没有安装Maven，也能构建项目。
  • pom.xml：Maven构建规范。
  • application.properties：最初该文件是空的，为我们提供制定配置属性的地方。
  • resources/static：存放任意为浏览器提供服务的静态内容。
  • resources/templates：存放用来渲染内容到浏览器的模板文件。

Spring Boot starter依赖它们本身不包含库代码，而是传递性的拉取其他的库。这样做的好处如下：

  • 构建文件会显著减小并易于管理。不必为每个所需的依赖库都声明依赖。
  • 能够根据它们所提供的功能来思考依赖，而不是库名称。
  • 不必担心库版本问题。可以相信给定版本的Spring Boot，传递性引入的库的版本是兼容的。只要关心Spring Boot版本就行。

Spring Boot maven plugin：1.提供一个maven goal，允许我们使用maven来运行应用。2.确保依赖的所有库都包含在可执行的jar文件中，并保证它们在运行时类路径下可用。3.它会在jar中生成一个manifest文件，将引导类声明为可执行jar主类。

@SpringBootApplication是一个组合注释，如下：

  1. @SpringBootConfiguration：将该类声明为配置类。实际上该注释是@Configuration的特殊形式。
  2. @EnableAutoConfiguration：启用Spring Boot的自动配置。
  3. @ComponentScan：启用组件扫描。

测试类带有@RunWith(SpringRunner.class)注解。其是Junit的注解，它会运行一个测试运行器(runner)来指导JUnit如何运行测试。本例子中为JUnit提供的是SpringRunner，这个是一个Spring提供的测试运行器，它会创建测试运行所需的Spring应用上下文。@SpringBootTest告诉JUit在启动测试时添加上Spring Boot功能

SpringRunner是SpringJUit4ClassRunner的别名，于Spring4.3引入，移除了对特定JUit版本的关联。

Spring自带一个强大的Web框架，Spring MVC。其核心是控制器的理念(处理请求并以某种方式进行信息响应的类)。

在Spring Boot2.2之后，默认的测试工具变成了Junit5。有两种方法进行测试:1.直接写@SpringBootTest，如果测试MVC加上注释@AutoConfigureMockMvc，注入一个Autowired的MockMvc对象。2.声明@ExtendWith(SpringExtension.class)替换@RunWith(SpringRunner.class)。设置@WebMvcTest(所需测试的Controller.class)。

import static org.hamcrest.Matchers.containsString;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.content;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.view;
//@SpringBootTest
//@AutoConfigureMockMvc
@ExtendWith(SpringExtension.class)
@WebMvcTest(HomeController.class)
public class HomeControllerTest{
    @Autowired
    private MockMvc mockMvc;
    @Test
    public void testHomePage() throws Exception {
        mockMvc.perform(get("/"))    // <3>

                .andExpect(status().isOk())  // <4>

                .andExpect(view().name("home"))  // <5>

                .andExpect(content().string(           // <6>
                        containsString("Welcome to...")));
    }
}

@RequestMapping：注释到类级别的时候，它能够指定该控制器所处理的请求类型。

在方法上的@GetMapping注释对类级别的@RequestMapping细化。GetMapping是Spring4.3引入，之前的是@RequestMapping(method=RequestMethod.GET)。

Spring MVC 的请求注解 描述
@RequestMapping 通用的请求处理
@GetMapping 处理HTTP GET请求
@PostMapping 处理HTTP POST请求
@PutMapping 处理HTTP PUT请求
@DeleteMapping 处理HTTP DELETE请求
@PatchMapping 处理HTTP PATCH请求

在为控制器方法声明请求映射时，越具体越好。意味着至少要声明路径(或者从类级别的QRequestMapping继承一个路径)以及它所处理的HTTP方法。推荐在类级别上使用@RequestMapping以便于指定基本的路径。在每个处理器方法上，使用更具体的@GetMapping或@PostMapping注解。

DevTools是Spring开发人员的开发期工具，包括：

  • 代码变更后应用自动重启。
  • 当面向浏览器的资源（如模板、Js、样式表）等发生变化时，会自动刷新浏览器。
  • 自动禁用模板缓存。
  • 如果使用了H2数据库，内置H2控制台。

当DevTools运行时，应用程序会被加载到Java虚拟机两个独立的类加载器中。其中一个类加载器会加载Jva代码、属性文件和项目中"src/main"路径下几乎所有的内容。另一个类加载器会加载依赖的库。当检测到变更时，DevTools只会重新加载包含项目代码的类加载器，并重启应用上下文。另一个类加载器和jvm保持不变，缩短应用启动时间。但导致自动重启无法反映依赖项的变化。需手动重新启动应用。DevTools在应用程序运行时，自启动一个LiveReload服务器。当LiveReload服务器与LiveReload浏览器插件结合时，有变化时自动刷新浏览器。

推荐使用Idea中的插件JRBEL

Tip

IDEA集成热部署

JRebel and XRebel for intellij（低版本叫JRebel for intellij，下方还有一个JRebel mybatisPlus extension是针对mybatis的mapper.xml的热部署）

修改Spring启动字符

每次spring项目启动时都会在终端打印SPRING。如果需要换成其他字符。在src/main/resources/路径下创建banner.txt即可。其中放入你想打印的字符。

Lombok

Lombok是一种JAVA的实用工具，可用来帮助开发人员消除JAVA的冗长，通过注解实现这一目的。

安装

  1. 添加lombok依赖

    <!--        lombok-->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>

  2. 在IDEA中安装lombok插件。这一步是保证IDEA不会将代码标红。虽然不安装该插件也不会影响运行，但是会导致IDEA标红。

常见的Lombok注释

lombok_overview.png

  • @Data：注解在类上。提供类所有属性的getter和setter方法，还提供了equals、hashCode、toString、RequiredArgsConstructor方法。

    lombok_data.png

  • @Setter：注解在属性上；为属性提供setting方法

  • @Getter：注解在属性上；为属性提供getting方法

    lombok_getter_setter.png

  • @ToString：自动重写toString方法

    lombok_tostring.png

  • @EqualAndHashCode

    自动生成equals(Object other)和hashCode()方法，包括所有非静态变量和非transient的变量

    lombok_equalsandhashcode.png

    如果某些变量不想要加进判断，可以透过exclude 排除，也可以使用of 指定某些字段

    lombok_equalsandhashcode_exclude.png

    Q :为什么只有一个整体的@EqualsAndHashCode注解，而不是分开的两个@Equals和@HashCode？

    A : 在Java 中有规定，当两个object equals 时，他们的hashcode 一定要相同，反之，当hashcode 相同时，object 不一定equals。所以equals 和hashcode 要一起implement，免得发生违反Java 规定的情形发生

  • @SneakyThrows：无需在签名处显式抛出异常

  • @Log4j：注释在类上；为类提供一个属性名为log的log4j日志对象

  • @Slf4j：同上。其作用同如下代码

    private static final org.slf4j.Logger log=org.slf4j.LoggerFactory.getLogger(DesignTacoController.class);

  • @NoArgsConstructor：注释在类上；为类提供一个无参的构造方法

    lombok_noargsconstructor.png

  • @AllArgsConstructor：注释在类上；为类提供一个全参的构造方法

    lombok_allargsconstructor.png

    这里注意一个Java 的小坑，当我们没有指定constructor 时，Java compiler 会帮我们自动生成一个没有任何参数的constructor 给该类，但是如果我们自己写了constructor 之后，Java 就不会自动帮我们补上那个无参数的constructor 了

    然而很多地方（像是Spring Data JPA），会需要每个类都一定要有一个无参数的constructor，所以你在加上@AllArgsConstructor时，拜托，一定要补上@NoArgsConstrcutor，不然会有各种坑等着你

    @AllArgsConstructor
@NoArgsConstructor
public class User {
    private Integer id;
    private String name;
}

  • @RequiredArgsConstructor：生成一个包含“特定参数”的constructor，特定参数指的是那些有加上final修饰词的变量们

    lombok_requiredargsconstructor.png

    如果所有的变量都是正常的，都没有用final 修饰的话，那就会生成一个没有参数的constructor。

  • @Value 基本与@Data相同，不同在于它会把所有变量设置为final。相应的也就没有setter方法了。

    lombok_value.png

    此lombok 的注解@Value 和另一个Spring 的注解@Value 撞名，在import 时不要import 错了。

  • @Builder，自动生成流式set 值写法，从此之后再也不用写一堆setter 了

    lombok_builder.png

    注意，虽然只要加上@Builder 注解，我们就能够用流式写法快速设定Object 的值，但是setter 还是必须要写不能省略的，因为Spring 或是其他框架有很多地方都会用到Object 的getter/setter对他们取值/赋值。所以通常是@Data 和@Builder 会一起用在同个类上，既方便我们流式写code，也方便框架做事。

    @Data
@Builder
public class User {
    private Integer id;
    private String name;
}

修改SpringBoot中Tomcat的服务端口

在配置文件src/main/resources/application.properties中修改或增加server.port=8000，其中8000就是指定的端口号，可以随意设置。

常用注解

@ResponseBody

返回字符串或JSON对象

@Controller

用于定义接口，是请求的入口。

@RestController

约等于@ResponseBody和@Controller的结合

@SpringBootApplication

SpringBoot启动入口处的注解

@RequestMapping

只是简单的使用@RequestMapping注解表示这个接口支持所有的请求方式

@GetMapping

不同于上一个@RequestMapping，其表示只接受get请求方式。或者写成@RequestMapping(value="/hello", method=RequestMethod.GET)，效果一样。

@ComponentScan

该注解实现了扫描包的功能。但是其只会扫描当前文件夹及其子文件夹的内容，对于上级或同级目录不会扫描。

使用时在需要添加扫描的类上加上这个注解，并在注解后面的括号中写上包名，如@ComponentScan("com.wangzhengbest.wiki")。**不要只写com,会扫描到第三方Jar,出错非常难排查。**使用@ComponentScan({"com.wangzhengbest","top.buerlog"})扫描多个包。

@Value

该注解可以将配置文件中的变量读取到程序中。例如@Value("${test.hello:Test}")就会去读取配置文件中的test.hello字段。后面的:Test表示这个值没有在配置文件中读取到时赋值为Test。

测试

在IDEA中可以创建以.http为结尾的文件来测试接口。在IDEA的设置中的实时模板中有创建测试的快捷指令。

Mybatis

使用方法

  1. 在pom.xml文件中添加依赖

    <!--        集成Mybatis-->
        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>2.1.3</version>
        </dependency>

<!--        集成mysql连接-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>
    </dependencies>

  2. 在配置文件中添加数据库信息，不添加这个信息直接运行会报错

    spring.datasource.url=jdbc:mysql://数据库ip/wiki?characterEncoding=UTF8&autoReconnect=true&serverTimeZone=Asia/Shanghai
spring.datasource.username=
spring.datasource.password=
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

mapper层设置完毕之后，还不能被spring扫描到。因此需要在启动spring的XXXApplication.java文件中添加上注解@MapperScan("com.wangzhengbest.WIKI.mapper")。这里的包路径就是mapper层的路径。

同理，sql对应的xml文件建立后，需要在application.properties文件中添加：

#配置mybatis所有Mapper.xml所在的路径
mybatis.mapper-locations=classpath:/mapper/**/*.xml

使用的时候使用注解@AutoWired。

项目结构

一般Spring项目中的源代码会分成几个层次：controller层（一般用来作为服务的入口），domain层（也可以叫POJO或entity，放置与数据库表一一映射的实体类），mapper层（持久层，也就是Dao层，生成的代码都以Mapper结尾）

文章作者: 不二
文章链接: http://buerlog.top/2020/08/13/cheng-xu-she-ji/java/spring-shi-zhan-xue-xi/
版权声明: 本博客所有文章除特別声明外，均采用 CC BY 4.0 许可协议。转载请注明来源 不二 !
Java Spring
赏
  目录