Spring Boot notes

• URL 参数处理

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

  package com.example.restservice;

  import java.util.concurrent.atomic.AtomicLong;

  import org.springframework.web.bind.annotation.GetMapping;
  import org.springframework.web.bind.annotation.RequestParam;
  import org.springframework.web.bind.annotation.RestController;


  @RestController
  public class GreetingController {

private static final String template = "Hello, %s!";
private final AtomicLong counter = new AtomicLong();

@GetMapping("/greeting") 
public Greeting greeting(@RequestParam(value = "name", defaultValue = "World") String name) {
   return new Greeting(counter.incrementAndGet(), String.format(template, name));
}
  }

1
2

  @RequestMapping(value = "/products")
  public ResponseEntity<Object> getProducts() { }

https://docs.spring.io/spring-boot/docs/2.3.2.RELEASE/reference/html/using-spring-boot.html#using-boot-starter 快捷设置依赖的一种方法

• 依赖名称使用前缀

  • spring-boot-starter-*

• value: 指定 URL 路径

• method: 请求的方法

  • RequestMethod.PUT
  • RequestMethod.GET
  • …

• 参数: value, 指定当前的路径

• 参数: value, 指定所有方法的父路径

  1 2 3 4 5 6 7 8 9

  // 用于类上，可以没有 @RequestMapping(value = "/controllerDemo") public class ControllerDemo { // 用于方法上，必须有 @RequestMapping(value = "/methodDemo") public String methodDemo() { return "helloWorld"; } }

• name: 指定名称
• value: name 的别名

• initMethod

  • 在 bean 实例化时，调用的方法

• destroyMethod

  • 在析构时，被调用的方法

• 使用 IoC 容器

  • context.getBean("yourBeanName")

• 自动装配@Autowired

  • 修饰要装配到的变量

    • eg: <<AutoWired Example>>

1
2

  // * 自动把别的地方 @Bean 生成的 MyBean 类型的 bean, 绑定到 myBean 变量上
  @Autowired private MyBean myBean;

• 使用@Bean

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

  @Configuration public class AppConfig { // 使用@Bean 注解表明myBean需要交给Spring进行管理 // * 未指定bean 的名称，默认采用的是 "方法名" + "首字母小写"的配置方式 @Bean public MyBean myBean(){ return new MyBean(); } } public class MyBean { public MyBean(){ System.out.println("MyBean Initializing"); } }

• 调用返回的对象

  1 2 3 4 5 6 7 8

  public class SpringBeanApplicationTests { public static void main(String[] args) { ApplicationContext context = new AnnotationConfigApplicationContext(AppConfig.class); // 调用 context.getBean("myBean"); } }

https://www.cnblogs.com/fnlingnzb-learner/p/9723834.html

• 把新建对象赋值到（装配）被注释的变量
• 对于接口 interface 类型，装配 其实现类的对象
• ref: @AutoWired Example

https://blog.csdn.net/yy_diego/article/details/88358180

• @Repository 是@Component 的派生

  • 因此被@Repository 注解的类，可以被@ComponentScan 通过路径扫描到

https://blog.csdn.net/weixin_42476601/article/details/86137375

• 三层分层架构

  • @Repository

    • 持久层 dao

  • @Service

    • 业务层

  • @Controller

    • 控制层 or Web 层

• @Component

  • 中立的类

• 都用来自动装配

• @Autowired

  • 按 type 装配
  • 属于 Spring 独有

• @Resources

  • 按 name 装配
  • 不属于 Spring 独有

https://blog.csdn.net/qq_36567005/article/details/80611139

https://blog.csdn.net/zhaoyishi/article/details/83964634

https://www.cnblogs.com/pjfmeng/p/7551340.html

• 修饰对象

  • 构造方法
  • 方法
  • 属性
• 按类型装配

• 位置

  • javax.inject.Inject

https://www.cnblogs.com/pjfmeng/p/7551340.html

• 基本作用域

  • singleton: 单例模式

    • 默认值
    • 整个 Spring IoC 容器中， 给定 bean 只有一个实例

  • prototype: 原型模式

    • 每次容器通过 getBean() 方法，都会产生一个新的实例

• Web 作用域

  • request

    • 每次 http request, 都会产生新的实例

  • session

    • 每次 http session, 都会产生新的实例

  • globalsession

    • 每个全局的 http session, 都会产生新的实例
• 自定义作用域

https://www.tutorialspoint.com/spring_boot/spring_boot_application_properties.htm 通过不同的设置方法来间接设置 Application Properties, 进而设置 Spring Application 的属性

1

  java -jar your_demo.jar -Dspring.config.location = C:\application.properties

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21

spring:
application:
 name: demoservice
server:
port: 8080

---
spring:
profiles: dev
application:
 name: demoservice
server:
port: 9090

---
spring: 
profiles: prod
application:
 name: demoservice
server: 
port: 4431

1
2
3
4
5
6

  <dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-configuration-preprocessor</artifactId>
</dependency>
  </dependencies>

• 使用位置

  • 在配置文件中

    1. Application Properties
    2. 外部配置文件
    3. xml 配置文件

• 例子

  • application.properties

    1 2	person.lastName = 张三${random.uuid} person.dogName = ${person.lastName}的狗

• 语法

  • ${random.uuid}

    • 调用预定义函数

• 随机数

  1 2	${random.uuid}, ${random.int}, ${random.long} ${random.int(10)}, ${random.int[1, 10]}

  • random.uuid
  • random.int
  • random.long

  • random.

    • ${person.lastName}

      • 引用其它变量

    • ${person.lastName:Lucy}

      • 引用不存在
• 设置默认值

• 用途

  • 用来包含，异常处理方法

    1 2 3 4 5 6 7

    @ControllerAdvice public class ProductExceptionController { @ExceptionHandler(value = ProductNotfoundException.class) public ResponseEntity<Object> exception(ProductNotfoundException exception) { return new ResponseEntity<>("Product not found", HttpStatus.NOT_FOUND); } }

• 普通扩展了 RuntimeException 的异常类

  1 2 3 4

  package com.tutorialspoint.demo.exception; public class ProductNotfoundException extends RuntimeException { private static final long serialVersionUID = 1L; }

1. 自定义异常类

   • RuntimeException 扩展，定义一个普通 runtime 异常类

2. @ControllerAdvice

   • 声明一个 Spring 异常处理类

3. @ExceptionHandler

   • 在异常处理类中，创建“自定义异常类”的异常处理函数

4. 使用自定义异常类

   • 在需要的地方，直接使用 throw 抛出即可

1. 实现 HandlerIntercepter 接口

   • 直接实现
   • 继承 HanderIntercepterAdapter 类（已经实现 HandlerIntercepter 接 口）
   • 实现 WebRequestInterceptor 类

• 直接实现

• 继承已经实现的类

  1. 使用@Component 注解

  2. 实现三个方法

     • preHandler()

• 作用位置

  • request 发给 Controler 之前

    • postHandler()

• 作用位置

  • response 发给 client 之前
  • View 视图 被渲染之前

  • 注：

    • View 渲染发生在 Controller 生成 Response 之后

      • afterComplete()

• 作用位置

  • View 被渲染之后

    • 总体流程
• request –> preHandler –> Controller –> postHandler –> View 渲染 —> afterComplete

• 把自定义 HandlerInterceptor, 注册（register）到 InterceptorRegistry

• 方法

  • 声明一个继承了 WebMvcConfigurerApp 的类

    • 作用：用来把自定义 Interceptor 自定义装配到它的上面

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

  @Component
  public class ProductServiceInterceptorAppConfig extends WebMvcConfigurerAdapter {
     @Autowired
     ProductServiceInterceptor productServiceInterceptor;

     @Override
     public void addInterceptors(InterceptorRegistry registry) {
 registry.addInterceptor(productServiceInterceptor);
     }
  }

1. 实现 javax.servlet.Filter 接口
2. 使用@Component 注解修饰

• 这里是 client 的上传

  • 操作流程

    • 从 file 中 读取，写入本地
    • 使用辅助类 MultipartFile

• 获取文件名：file.getOriginalFilename()
• 读取字节流：file.getBytes()

1
2

  @RequestMapping(value = "/upload", method = RequestMethod.POST, 
		  consumes = MediaType.MULTIPART_FORM_DATA_VALUE)

• 这里是 client 的下载

  • 操作流程

    • 从 localFile 中 读取，传给 client
    • 把 文件读取流 赋值给 body

• 注意

  • 还需要设置 Reponse 头文件

• 跨域名：即两个不同的域名，如：www.baidu.com 和 wwww.ifeng.com
• 跨端口号：域名相同，端口号不同，如：localhost:80 与 localhost:8080
• 跨协议

• ajax, XMLHttpRequest 请求
• js fetch API https://www.jianshu.com/p/f817490796d3
• web 字体 @font-face
• WebGL textures
• drawImage –> 绘制 canvas
• 样式表（CSSOM）

• 注意

  • 直接请求数据，不被限制

    • 如：直接请求加载 别的网站的图片

• origins 属性

  • 允许跨源的网站

• 作用对象

  • 和 @RestMapping 一起使用，作用于方法

    1 2 3 4 5 6

    @RequestMapping(value = "/products") @CrossOrigin(origins = "http://localhost:8080") public ResponseEntity<Object> getProduct() { return null; }

• 使用 @Configuration + @Bean 实现配置

  • 配置类：WebMvcConfigurer

  1 2 3 4 5 6 7 8 9

  @Bean public WebMvcConfigurer corsConfigurer() { return new WebMvcConfigurerAdapter() { @Override public void addCorsMappings(CorsRegistry registry) { registry.addMapping("/products").allowedOrigins("http://localhost:9000"); } }; }

• @Bean 配置

  • 配置类： LocaleResolver

    1 2 3 4 5 6

    @Bean public LocaleResolver localeResolver() { SessionLocaleResolver sessionLocaleResolver = new SessionLocaleResolver(); sessionLocaleResolver.setDefaultLocale(Locale.US); return sessionLocaleResolver; }

• @Bean 配置

  • 配置类：LocaleChangeInterceptor

• 用来配置不同的 locale 常用词语或句子

  1	welcome.text = Hi Welcome to Everyone

• 使用

  • 配合 Thymeleaf template 使用

    1 2 3

    <body> <h1 th:text = "#{welcome.text}"></h1> </body>

• 使用 keytool 命令（jdk 提供）

  1	keytool -genkey -alias tomcat -storetype PKCS12 -keyalg RSA -keysize 2048 -keystore keystore.p12 -validity 3650

  • -keystore: 指定产生文件的名字

https://www.tutorialspoint.com/spring_boot/spring_boot_eureka_server.htm

• 与 @SpringBootApplication 一起使用

1
2
3
4
5
6

  eureka:
client:
 registerWithEureka: false
 fetchRegistry: false
  server:
port: 8761

https://www.tutorialspoint.com/spring_boot/spring_boot_service_registration_with_eureka.htm

• Eureka Client
• 即，在 Rest Service 网站，开启 Eureka Client 功能
• 与 @SpringBootApplication 一起使用

1
2
3
4
5
6
7
8
9

  eureka:
client:
serviceUrl:
 defaultZone: http://localhost:8761/eureka
instance:
   preferIpAddress: true
  spring:
application:
name: eurekaclient

• Eureka Client
• 与 @SpringBootApplication 一起使用

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

  server:
port: 8080
  spring:
application:
name: user-consumer # 应用名称
  eureka:
client:
service-url: # EurekaServer地址
 defaultZone: http://127.0.0.1:10086/eureka
instance:
prefer-ip-address: true # 当其它服务获取地址时提供ip而不是hostname
ip-address: 127.0.0.1 # 指定自己的ip信息，不指定的话会自己寻找

• 只需要 在 maven 中导入依赖即可， 不用修改程序本身

• containsBean(String name) 方法

  1	boolean flag = ioc.containsBean("yoru_class_name")