Day622.Spring编程错误根源 -Spring编程常见错误

Posted 2022-05-20 阿昌喜欢吃黄桃

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了Day622.Spring编程错误根源 -Spring编程常见错误相关的知识，希望对你有一定的参考价值。

Spring编程错误根源

我们使用Spring中会出现很多很多的问题，梳理下关于 Spring 使用中常见的一些错误根源。

一、隐式规则的存在

要想使用好 Spring，你就一定要了解它的一些潜规则，例如默认扫描 Bean 的范围、自动装配构造器等等。如果我们不了解这些规则，大多情况下虽然也能工作，但是稍微变化，则可能完全失效，例如在之前的博客中，我们使用 Spring Boot 来快速构建了一个简易的 Web 版 HelloWorld：

其中，负责启动程序的 Application 类定义如下：

//省略 import
@SpringBootApplication
public class Application 
    public static void main(String[] args) 
        SpringApplication.run(Application.class, args);

提供接口的 HelloWorldController 代码如下：

//省略 import
@RestController
public class HelloWorldController 
    @RequestMapping(path = "hi", method = RequestMethod.GET)
    public String hi()
         return "helloworld";
    ;

但是，假设有一天，当我们需要添加多个类似的 Controller，同时又希望用更清晰的包层次结构来管理时，我们可能会去单独建立一个独立于 application 包之外的 Controller 包，并调整类的位置。调整后结构示意如下：

这样就会工作不起来了，追根溯源，你可能忽略了 Sping Boot 中 @SpringBootApplication 是有一个默认的扫描包范围的。

这就是一个隐私规则。如果你原本不知道，那么犯错概率还是很高的。

二、默认配置不合理

Spring 默认的配置不见得是合理的。

你可以思考这样一个问题，如果让我们写一个框架，我们最大的追求肯定是让用户“快速上手”，这样才好推广。

所以我们肯定不会去写一堆配置，而是采用默认值的方式。但是这里面你提出的默认值一定是用户需要的么？未必。这时候，你可能会妥协地满足 80% 的用户使用场景。

所以在使用时，你一定要考虑自己是不是那多余的 20%。一起复习这样一个的案例，在之前的博客中，当我们什么都不去配置，而是直接使用 Spring Data Cassandra 来操作时，我们实际依赖了 Cassandra driver 内部的配置文件，具体目录如下：

.m2\\repository\\com\\datastax\\oss\\java-driver-core\\4.6.1\\java-driver-core-4.6.1.jar!\\reference.conf

我们可以看下它存在很多默认的配置，其中一项很重要的配置是 Consistency，在 driver 中默认为 LOCAL_ONE，具体如下：

basic.request 
  # The consistency level.
  #
  # Required: yes
  # Modifiable at runtime: yes, the new value will be used for requests issued after the change.
  # Overridable in a profile: yes
  consistency = LOCAL_ONE
//省略其他非关键配置

当你第一次学习和应用 Cassandra 时，你一定会先只装一台机器玩玩。

此时，设置为 LOCAL_ONE 其实是最合适的，也正因为只有一台机器，你的读写都只能命中一台。

这样的话，读写是完全没有问题的。但是产线上的 Cassandra 大多都是多数据中心多节点的，备份数大于 1。

所以读写都用 LOCAL_ONE 就会出现问题。

所以这样说，你就理解了我要表达的意思了吧？Spring 采用了一堆默认配置有其原因，但不见得适合你的情况。

三、追求奇技淫巧

Spring 给我们提供了很多易用的可能，然后有时候，你用着用着会觉得，Spring 怎么用都能工作起来，特别是你在网上看到了一些更简洁高效的写法之后，你会觉得惊喜，原来这样也可以。

但是 Spring 真的是无所不能地随意使用么？这里之前的博客，我们常常使用 @RequestParam 和 @PathVarible 来获取请求参数（request parameters）以及 path 中的部分。

但是在频繁使用这些参数时，不知道你有没有觉得它们的使用方式并不友好，例如我们去获取一个请求参数 name，我们会定义如下：

@RequestParam(“name”) String name

此时，我们会发现变量名称大概率会被定义成 RequestParam 值。所以我们是不是可以用下面这种方式来定义：

@RequestParam String name

这种方式确实是可以的，本地测试也能通过。这里我给出了完整的代码，你可以感受下这两者的区别：

@RequestMapping(path = "/hi1", method = RequestMethod.GET)
public String hi1(@RequestParam("name") String name)
    return name;
;

@RequestMapping(path = "/hi2", method = RequestMethod.GET)
public String hi2(@RequestParam String name)
    return name;
;

很明显，对于喜欢追究极致简洁的同学来说，这个酷炫的功能是一个福音。

但当我们换一个项目时，有可能上线后就失效了，然后报错 500，提示匹配不上。

Spring 虽然强大，看起来怎么都能玩转，但是实际并非一定如此。

四、理所当然地使用

在使用 Spring 框架时，有时候，我们会不假思索地随意下结论。

例如，我们在处理 HTTP Header 遇到需要处理多个 Header 时，我们第一反映是使用一个 HashMap 来接收，但是会满足所有情况么？

之前的博客，在 Spring 中解析 Header 时，我们在多数场合中是直接按需解析的。

例如，我们想使用一个名为 myHeaderName 的 Header，我们会书写代码如下：

@RequestMapping(path = "/hi", method = RequestMethod.GET)
public String hi(@RequestHeader("myHeaderName") String name)
   //省略 body 处理
;

定义一个参数，标记上 @RequestHeader，指定要解析的 Header 名即可。

但是假设我们需要解析的 Header 很多时，按照上面的方式很明显会使得参数越来越多。

在这种情况下，我们一般都会使用 Map 去把所有的 Header 都接收到，然后直接对 Map 进行处理。于是我们可能会写出下面的代码：

@RequestMapping(path = "/hi1", method = RequestMethod.GET)
public String hi1(@RequestHeader() Map map)
    return map.toString();
;

粗略测试程序，你会发现一切都很好。而且上面的代码也符合针对接口编程的范式，即使用了 Map 这个接口类型。但是上面的接口定义在遇到下面的请求时，就会超出预期。请求如下：

GET http://localhost:8080/hi1
myheader: h1
myheader: h2

这里存在一个 Header 名为 myHeader，不过这个 Header 有两个值。此时我们执行请求，会发现返回的结果并不能将这两个值如数返回。结果示例如下：

myheader=h1, host=localhost:8080, connection=Keep-Alive, user-agent=Apache-HttpClient/4.5.12 (Java/11.0.6), accept-encoding=gzip,deflate

实际上，要完整接收到所有的 Header，不能直接使用 Map 而应该使用 MultiValueMap。

借着这个案例，可以思考下你为什么会出错？

因为你肯定知道要用一个 Map 来接收，也相信一定可以，但是你可能疏忽了你用的 Map 是 Spring 给你返回的 Map。

所以有时候，一些“理所当然”的结论其实是错误的。一定要大胆假设、小心求证，才能规避很多问题。

五、无关的依赖变动

Spring 依赖了大量的其他组件来协同完成功能，但是完成同一个功能的组件却可能存在多种工具，例如 Spring 完成 JSON 操作，既可以依赖 Gson，也可以依赖 Jackson。

更可怕的是 Spring 往往是动态依赖的，即优先看看优选的工具是否存在，存在则用，不存在才看其他依赖的工具类型是否存在。

这样的逻辑会导致项目的依赖不同时，依赖的工具也不同，从而引发一些微妙的行为“变化”。

之前的博客，首先看下面这段代码：

@RestController
public class HelloController 
    @PostMapping("/hi2")
    public Student hi2(@RequestBody Student student) 
        return student;

这段代码接收了一个 Student 对象，然后原样返回。我们使用下面的测试请求进行测试：

POST http://localhost:8080/springmvc3_war/app/hi2
Content-Type: application/json

“name”: “xiaoming”

经过测试，我们会得到以下结果：

“name”: “xiaoming”

但是随着项目的推进，在代码并未改变时，我们可能会返回以下结果：

“name”: “xiaoming”,“age”: null

即当 age 取不到值，开始并没有序列化它作为响应 Body 的一部分，后来又序列化成 null 作为 Body 返回了。

如果我们发现上述问题，那么很有可能是上述描述的依赖变动造成的。

具体而言，在后续的代码开发中，我们直接依赖或者间接依赖了新的 JSON 解析器，例如下面这种方式就依赖了 Jackson：

<dependency>
     <groupId>com.fasterxml.jackson.core</groupId>
     <artifactId>jackson-databind</artifactId>
     <version>2.9.6</version>
 </dependency>

诸如此类问题，一般不会出现严重的问题，但是你一定要意识到，当你的代码不变时，你的依赖变了，行为则可能“异常”了。

六、通用错误

实际上，除了上面的一些原因外，还有不少错误是所有类似 Spring 框架都要面对的问题。例如，处理一个 HTTP 请求，Path Variable 含有特殊字符 / 时，一般都会有问题，大多需要额外的处理。

之前的博客在解析一个 URL 时，我们经常会使用到 @PathVariable 这个注解。例如我们会经常见到如下风格的代码：

@RestController
@Slf4j
public class HelloWorldController 
    @RequestMapping(path = "/hi1/name", method = RequestMethod.GET)
    public String hello1(@PathVariable("name") String name)
        return name;
        
    ;