SpringMVC学习记录（二）：SpringMVC部分注解学习

2023-11-14 23:10:22

既然要学习Spring那就要学注解，SpringMVC也有对应的注解。

一、SpringMVC常用注解。

（一）绑定url的注解

① @RequestMapping 在类使用，也可以在方法使用

属性：value/path：表示绑定url

method：默认值处理GET/POST 默认值是一个集合：RequestMethod[]

②@ResponseBody 在类上使用表示这个类中的所有方法都返回JSON数据，也可以在方法上使用表示这个方法返回JSON数据

使用案例：

springmvc.xml配置：

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:mvc="http://www.springframework.org/schema/mvc"
       xmlns:context="http://www.springframework.org/schema/context"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
       http://www.springframework.org/schema/beans/spring-beans.xsd
       http://www.springframework.org/schema/mvc
       http://www.springframework.org/schema/mvc/spring-mvc.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd">


    <!--配置处理器
       以处理器的bean的name作为处理器请求的url
    -->
    <bean name="/user.do" class="com.fs.controller.UserHandler"/>
    <!--配置处理器映射器-->
    <bean class="org.springframework.web.servlet.handler.BeanNameUrlHandlerMapping"/>

    <!--配置处理器适配器
       类:
        方法 public boolean supports(Object handler) {
                return handler instanceof Controller;
            }
           SimpleControllerHandlerAdapter: 只能处理实现Controller接口的处理器
    -->
    <bean class="org.springframework.web.servlet.mvc.SimpleControllerHandlerAdapter"/>

    <!--视图解析器 如果前后台分离, 不需要配置视图解析器-->
    <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">
        <!-- 逻辑视图名: user:
           prefix +逻辑视图名+suffix
           WEB-INF/jsp/user.jsp
         -->
        <!--prefix: 前缀-->
        <property name="prefix" value="WEB-INF/jsp/"></property>
        <!--suffix: 后缀-->
        <property name="suffix" value=".html"></property>
    </bean>

    <!--开启注解的处理器适配器注解的处理器映射器-->
    <mvc:annotation-driven/>
    <mvc:default-servlet-handler/>
    <context:component-scan base-package="com.fs.controller"/>

</bean>

导入依赖：

  <dependencies>
    <dependency>
      <groupId>junit</groupId>
      <artifactId>junit</artifactId>
      <version>4.12</version>
      <scope>test</scope>
    </dependency>

    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-webmvc</artifactId>
    </dependency>

    <dependency>
      <groupId>org.slf4j</groupId>
      <artifactId>slf4j-log4j12</artifactId>
      <version>1.7.25</version>
    </dependency>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-test</artifactId>
    </dependency>

    <!--Servlet-api-->
    <dependency>
      <groupId>javax.servlet</groupId>
      <artifactId>javax.servlet-api</artifactId>
      <version>3.0.1</version>
      <scope>provided</scope>
    </dependency>

    <dependency>
      <groupId>javax.servlet.jsp</groupId>
      <artifactId>jsp-api</artifactId>
      <version>2.1</version>
      <scope>provided</scope>
    </dependency>

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

  <build>
    <finalName>springmvc-helloworld</finalName>
    <pluginManagement><!-- lock down plugins versions to avoid using Maven defaults (may be moved to parent pom) -->
      <plugins>
        <plugin>
          <artifactId>maven-clean-plugin</artifactId>
          <version>3.1.0</version>
        </plugin>
        <!-- see http://maven.apache.org/ref/current/maven-core/default-bindings.html#Plugin_bindings_for_war_packaging -->
        <plugin>
          <artifactId>maven-resources-plugin</artifactId>
          <version>3.0.2</version>
        </plugin>
        <plugin>
          <artifactId>maven-compiler-plugin</artifactId>
          <version>3.8.0</version>
        </plugin>
        <plugin>
          <artifactId>maven-surefire-plugin</artifactId>
          <version>2.22.1</version>
        </plugin>
        <plugin>
          <artifactId>maven-war-plugin</artifactId>
          <version>3.2.2</version>
        </plugin>
        <plugin>
          <artifactId>maven-install-plugin</artifactId>
          <version>2.5.2</version>
        </plugin>
        <plugin>
          <artifactId>maven-deploy-plugin</artifactId>
          <version>2.8.2</version>
        </plugin>
      </plugins>
    </pluginManagement>
  </build>

配置web.xml：

<!DOCTYPE web-app PUBLIC
 "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"
 "http://java.sun.com/dtd/web-app_2_3.dtd" >

<web-app>
  <display-name>Archetype Created Web Application</display-name>
  <!--全局的初始化参数-->
  <!--   <context-param>
         <param-name></param-name>
         <param-value></param-value>
     </context-param>-->
  <!--配置前端控制器
      启动的时候,创建一个springmvc容器(spring)
       默认加载的配置文件: 默认的配置文件: WEB-INF/{servlet-name}.xml      WEB-INF/springmvc.xml

       springmvc创建时机: 第一次请求的时候
         设置让这个Servlet(DispatcherServlet) 在服务器启动时候创建:
           配置: load-on-startup   值 非负整数  数字越小, 越先启动

  -->
  <servlet>
    <servlet-name>springmvc</servlet-name>
    <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
    <!--Servlet的初始化参数, 只能在该Servlet获取-->
    <init-param>
      <param-name>contextConfigLocation</param-name>
      <param-value>classpath:springmvc.xml</param-value>
    </init-param>
    <load-on-startup>1</load-on-startup>
  </servlet>

  <servlet-mapping>
    <servlet-name>springmvc</servlet-name>
    <!--请求的路径
        1)    /*  错误写法, 因为, /* 所有的请求都会经过前端控制器, 经过前端控制器, 根据url查找处理器
                        jsp页面.经过前端控制器, 查询jsp的url的处理器, 肯定找不到, 报错 处理器找不到
        2)  /   Restfull 风格的写法, 所有的请求都会经过前端控制器,除以.jsp结尾的url, 静态资源(css,js,html,图片..)
                      经过前端控制器, 根据url查找处理器, 后期需要对静态资源过滤
        3) *.do/*.action       以.do或者.action结尾的url经过前端控制
        -->

    <url-pattern>/</url-pattern>
  </servlet-mapping>

</web-app>

写入一个test测试类Controller ：

如果在类上加了@RequestMapping("/a"),然后又在方法上加了@RequestMapping("/test1")

那么访问这个端口的路径就是：localhost:xxxx/a/test1

@Controller
//可以不写，那就只需要访问方法上的RequestMapping路径即可
//@RequestMapping("/user")
public class test{
    //只处理get方法
    @GetMapping("/test1")
    @ResponseBody
    public User test1(){
        User user = new User();
        user.setUsername("admin");
        user.setPassword("123456");
        return user;
    }

}

然后我们去访问端口测试：

访问成功返回JSON数据

绑定url也有其他的注解，但是也是基于@RequestMapping():

@PostMapping("/test1")    post请求
@GetMapping("/test1")    get请求
@DeleteMapping("/test1") delete请求
@PutMapping("/test1")   put请求
@PatchMapping("/test1")   patch请求

（二）传参问题

如果test1方法需要传入参数String username和String password：

    @GetMapping("/test1")
    @ResponseBody
    public User test1(String username,String password){
        User user = new User();
        user.setUsername(username);
        user.setPassword(password);
        return user;
    }

那么接受参数就要分两种情况：

①当前端传入的参数名和后端收到的参数名一致时：

SpringMVC会根据前端传入的参数名自动匹配后端与之匹配的参数名

②当前端传入的参数名和后端接收的参数名不一致时：

那么我们需要使用一个注解：@RequestParam()

这个注解有三个常用参数：

          1）name: 请求参数名, 把指定请求参数名与形参进行映射
          2）required: 默认值: true 是否必须, 如果为true表示必须, 如果前端没有传递该参数:                                 抛出:400如果为false,不是必须, 如果前端没有传递数据, 参数值为null。
        3）defaultValue: 默认值

举例：现在我们后端的使用的参数名是“username”，但是我们映射的前端传入的参数名是“name”

    @GetMapping("/test1")
    @ResponseBody
    public User test1(@RequestParam("name") String username, String password){
        User user = new User();
        user.setUsername(username);
        user.setPassword(password);
        return user;
    }

然后我们修改前端传入的参数为name：

③同样的，SpringMVC也会根据前端传入的参数名自动映射实体类中的参数名：

举例，我把User对象当成接收的参数：

@Data
public class User {
    private String username;
    private String password;
}

    @GetMapping("/test1")
    @ResponseBody
    public User test1(User user){
        return user;
    }

然后前端传入参数username和password，结果：

④@PathVariabl()

　　用于将请求URL中的模板变量映射到功能处理方法的参数上，即取出uri模板中的变量作为参数。如：

 @RequestMapping(value="/test1/username/{username}/password/{password}",method = RequestMethod.GET)  
     public String getLogin(@PathVariable("username") String username,  
         @PathVariable("password") String password){  
         User user = new User();
         user.setUsername(username);
         user.setPassword(password);
         return user;  
     }

⑤@CookieValue

　　作用：用来获取Cookie中的值；

　　参数： value：参数名称 required：是否必须 defaultValue：默认值

@RequestMapping("/test")
    public String testCookieValue(@CookieValue("username") String username) {
        return username;
    }

⑥@SessionAttributes

@SessionAttributes即将值放到session作用域中，写在class上面。　　

　　@SessionAttributes 除了可以通过属性名指定需要放到会话中的属性外（value 属性值），

还可以通过模型属性的对象类型指定哪些模型属性需要放到会话中（types 属性值）,例如：

@SessionAttributes(value = {"user"}, types = {String.class})
@Controller
public class test{
    
     //@SessionAttributes
     //除了可以通过属性名指定需要放到会话中的属性外（value 属性值），
     //还可以通过模型属性的对象类型指定哪些模型属性需要放到会话中（types 属性值）。
     //注意： 该注解只能放在类的上面，不能放在方法上面
    @RequestMapping("/test1")
    public String test(Map<String, Object> map) {
        User user = new User("username","password");
        map.put("user", user);
        map.put("test", "重庆");
        return "success";
    }
}

那么SpringMVC常用的注解到这里就结束了，当然这还没完，SpringMVC还提供了很多的注解，所以感兴趣的小伙伴可以前往官方文档查询！

码农公寓