💠

💠 2024-11-22 11:50:47

SpringBoot

Doc

SpringBoot2
SpringBoot3

思考

参考教程

Guide 小马哥书籍《Spring Boot 编程思想》示例工程

系列

使用SpringBootCLI

  • 使用 SDKMAN 进行安装
    • 使用git bash运行 curl -s get.sdkman.io | bash
    • source "/Users/{yourname}/.sdkman/bin/sdkman-init.sh" 根据实际目录去运行
    • spring –version
  • 官方下载地址 所有版本

Profils

Spring Profiles

配置文件(application.properties或者yml) 加载顺序 | 官方文档说明

  1. 当前Jar/War目录下的/config目录 ./config/
  2. 当前目录 ./
  3. classpath 里的/config目录 classpath:/config/
  4. classpath 根目录 classpath:/

自定义配置文件名就要运行时加参数

  1. java -jar myproject.jar --spring.config.name=myproject
  2. java -jar myproject.jar --spring.config.location=classpath:/default.properties,classpath:/override.properties

参考: Spring Boot(五) - 外化配置

多种配置文件并切换

yml方式

  • 单文件多环境 配置文件 application.yml 
     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

        spring:
    profiles:
        active: development # 选用开发模式
    ---
    spring:
    profiles: development
    # 一系列配置
    ---
    spring:
    profiles: production
    #  一系列配置
  • 多文件存放不同环境配置 application-{profile}.yml

yml和properties结合

  • 格式：application-{profile}.properties
  • 将上面的开发部分，发行部分的配置创建两个配置文件 application-dev.properties 和 application-prod.properties
  • 在主配置文件application.yml中指明 
    1
2
3

        spring:
    profiles:
        active: dev # dev或prod,也可以 common,dev 启用两份

应用配置文件

依赖于 org.springframework.boot:spring-boot-configuration-processor

配置对应的实体类

1
2
3
4
5
6

    @Data
    @Component
    @ConfigurationProperties(prefix = "graduate.main")
    public class MainConfig {
        private String delimiter;
    }

应用配置类

1
2
3
4

    @Configuration
    @EnableConfigurationProperties(MainConfig.class)
    public class AutoCustomConfig {
    }

application.yml

1
2
3

graduate:
  main:
    delimiter: ,

Events

Note: Spring Events

配置成异步并使用线程池

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

    @Configuration
    public class AsynchronousSpringEventsConfig {
        @Bean(name = "applicationEventMulticaster")
        public ApplicationEventMulticaster simpleApplicationEventMulticaster() {
            SimpleApplicationEventMulticaster eventMulticaster = new SimpleApplicationEventMulticaster();

            SimpleAsyncTaskExecutor taskExecutor = new SimpleAsyncTaskExecutor();
            eventMulticaster.setTaskExecutor(taskExecutor);
            return eventMulticaster;
        }
    }

Logging

默认可以通过 application.properties 配置框架的日志,以及应用具体到包和类的日志等级,日志文件等等

参考: Spring boot——logback 基础使用篇（一） 参考: springboot use logback能根据Profile配置,还能写if
spring boot logging

使用logback时需要配置 logback.xml 或者 logback-spring.xml 建议使用后者

  • 思考: 能否不同的包使用不同的pattern pattern
    • 但是不利于后续中间件做日志解析
  • 配置 pattern 并引用 MDC logging.pattern.level=%X{mdcData}%5p

Cache

Caching Data with Spring | SpringBoot: Caching

Spring Boot Cache使用与整合

  • @Cacheable：表示该方法支持缓存。当调用被注解的方法时，如果对应的键已经存在缓存，则不再执行方法体，而从缓存中直接返回。当方法返回null时，将不进行缓存操作。
    • cacheNames/value：缓存组件的名字，即cacheManager中缓存的名称。
    • key：缓存数据时使用的key。默认使用方法参数值，也可以使用SpEL表达式进行编写。
      • 调用静态方法获取用户id拼接进SpEL，从而实现用户缓存隔离
    • keyGenerator： 和key二选一使用
      • 可以默认构造一个自定义的生成器，从线程上下文获取用户id拼接进去实现用户缓存隔离
    • cacheManager：指定使用的缓存管理器。
    • condition：在方法执行开始前检查，在符合condition的情况下，进行缓存。
    • unless：在方法执行完成后检查，在符合unless的情况下，不进行缓存。
    • sync：是否使用同步模式。若使用同步模式，在多个线程同时对一个key进行load时，其他线程将被阻塞。Spring 4.1引入，规避缓存击穿
  • @CachePut：表示执行该方法后，其值将作为最新结果更新到缓存中。
  • @CacheEvict：表示执行该方法后，将触发清除同名value和key的缓存。
  • @Caching：可组合前三个注解

注意缓存的本质是将内存对象序列化到三方缓存（JVM，Redis，文件），使用时再反序列化， 所以需要缓存的接口的参数和响应值都需要实现Serializable接口

Web模块

Lisener

ServletContextListener

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

    @WebListener
    public class ApplicationContext implements ServletContextListener {
    @Override
    public void contextInitialized(ServletContextEvent event) {
        System.out.println("Servlet容器初始化");
    }

    @Override
    public void contextDestroyed(ServletContextEvent event) {
        System.out.println("Servlet容器销毁");
    }
    }

上传下载文件

第一种直接上传到应用的webroot或者resources目录下，第二种上传到数据库中，第三种使用ftp。

  • Springboot上传文件
  • 上传文件有大小限制，使用如下方法进行配置 参考博客 
    1
2
3
4
5
6
7
8
9

    @Bean
public MultipartConfigElement multipartConfigElement() {
    MultipartConfigFactory factory = new MultipartConfigFactory();
    //单个文件最大
    factory.setMaxFileSize("80MB"); //KB,MB
    // 设置总上传数据总大小
    factory.setMaxRequestSize("102400KB");
    return factory.createMultipartConfig();
}

错误页面跳转配置

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

@Configuration
public class MvcConfig extends WebMvcConfigurerAdapter {
    @Bean
    public EmbeddedServletContainerCustomizer containerCustomizer() {
        return (container -> {
            ErrorPage error401Page = new ErrorPage(HttpStatus.FORBIDDEN, "/403.html");
            ErrorPage error404Page = new ErrorPage(HttpStatus.NOT_FOUND, "/404.html");
            ErrorPage error500Page = new ErrorPage(HttpStatus.INTERNAL_SERVER_ERROR, "/500.html");
            container.addErrorPages(error401Page, error404Page, error500Page);
        });
    }
}

跨域

不同的域名（主机）端口都会导致跨域问题

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16

@Configuration
public class CorsConfig {
    private CorsConfiguration buildConfig() {
        CorsConfiguration corsConfiguration = new CorsConfiguration();
        corsConfiguration.addAllowedOrigin("*"); // 允许任何域名使用
        corsConfiguration.addAllowedHeader("*"); // 允许任何头
        corsConfiguration.addAllowedMethod("*"); // 允许任何方法（post、get等）
        return corsConfiguration;
    }
    @Bean
    public CorsFilter corsFilter() {
        UrlBasedCorsConfigurationSource source = new UrlBasedCorsConfigurationSource();
        source.registerCorsConfiguration("/**", buildConfig()); // 4
        return new CorsFilter(source);
    }
}

全局异常处理

  1. 新建类 并加类注解 ControllerAdvice 或 RestControllerAdvice（省去方法ResponseBody）
  2. 新建方法上添加注解 ExceptionHandler(Exception.class) 处理对应异常类型
  3. 然后返回值的写法和普通Controller一样, 返回JSON就ResponseBody

Validator

Validation with Spring Boot

SpringBoot接口 - 如何对参数进行校验

1
2
3
4

    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-validation</artifactId>
    </dependency>

Response

全局切面增强

  1. 自定义一个切面 implements ResponseBodyAdvice<Object>
    1. 重写 supports 和 beforeBodyWrite 并依据 后者的 body和returnType参数自行封装成统一结构
    2. 降低Mvc接口层 Result<List<Item>> 等结构，简化为 List<Item>， 异常返回可以用全局异常处理成Result结构

Graceful Response

测试模块

1
2
3
4
5
6
7
8

    // 依赖于Springboot环境的测试类的必备注解
    @RunWith(SpringRunner.class)
    @SpringBootTest

    // 使用内存数据库测试
    @ComponentScan("com.github.kuagncp") // 如果有类没注入需要手动设置扫面
    @RunWith(SpringJUnit4ClassRunner.class)
    @DataJpaTest
  • 可以使用MockMvc来测试Controller层的代码
  • 可以使用MockMvc的SpringSecurity支持来测试安全模块
  • 使用 WebIntegraionTest 测试运行中的Web容器
    • 启动嵌入式的Servlet容器来进行测试，下断言
  • 使用随机端口启动服务器 配置local.server.port=0
  • 使用Selenium来测试HTML页面，模拟浏览器的动作，查看系统运行状态

运行和部署

mvn 运行

  • Spring Boot Maven Plugin
  • 例如开启远程调试 mvn spring-boot:run -Dspring-boot.run.jvmArguments="-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=n,address=8000"

编译打包jar/war

war

  • 部署为war必须的类，一般在创建项目时选war就会自动生成，选jar就要手动添加
1
2
3
4
5
6

    public class ServletInitializer extends SpringBootServletInitializer {
        @Override
        protected SpringApplicationBuilder configure(SpringApplicationBuilder application) {
            return application.sources(DemoApplication.class);
        }
    }
  • maven： mvn war 即可 mvn package -DskipTests
  • gradle: gradle war 然后 gradle bootRepackage 即可

jar

  • 没有特殊的配置，打包即用 java -jar app.jar
    • maven: mvn package 即可生成可执行的jar
    • gradle:gradle jar 然后 gradle bootRepackage 也生成可执行jar

二进制执行的Jar

Installing Spring Boot Applications
launch.script启动脚本

构建Docker镜像

Official Doc: spring boot docker

手动方式

  • 先构建得到war或jar，然后根据dockerfile构建一个镜像
1
2
3

    FROM frolvlad/alpine-oraclejdk8:slim
    ADD weixin-1.0.0.war app.war
    ENTRYPOINT ["java","-jar","/app.war"]

热部署

参考: SpringBoot热部署

IDE调试时： getBean() 报错cannot be cast to class is in unnamed module of loader ‘app’ Spring Boot DevTools - RestartClassLoader problem
spring boot dev tools 实现的 RestarterClassLoader类加载器 和 AppClassLoader 共存，会有一些Bean在Restart类加载器里
方法： -Dspring.devtools.restart.enabled=false 禁用或者移除依赖

运行性能优化

Runtime efficiency with Spring (today and tomorrow)