SpringMVC笔记：使用注解开发

SpringMVC通常使用注解进行开发，方便快捷，可读性也更高，常用的注解有@Controller，@RequestMapping，@GetMapping，@PostMapping，@PutMapping，@DeleteMapping，@PathVariable，@RequestParam，@ResponseBody等，基础使用方式见示例。

1. 基础配置

web.xml配置

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_4_0.xsd"
         version="4.0">
    <!-- 1. 注册DispatcherServlet：请求分发器，或者叫前端控制器 -->
    <servlet>
        <servlet-name>springmvc</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <init-param>
            <param-name>contextConfigLocation</param-name>
            <!-- 需要在classpath下（即src/main/resources目录）创建这个xml -->
            <param-value>classpath:springmvc-servlet.xml</param-value>
        </init-param>
        <!-- 启动级别1：表示这个servlet随服务器启动一起启动 -->
        <load-on-startup>1</load-on-startup>
    </servlet>

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

    <!-- 2. 配置SpringMVC乱码过滤器 -->
    <filter>
        <filter-name>encoding</filter-name>
        <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
        <init-param>
            <param-name>encoding</param-name>
            <param-value>utf-8</param-value>
        </init-param>
    </filter>
    <filter-mapping>
        <filter-name>encoding</filter-name>
        <!-- 这里必须是/*，如果只是/，那就只会处理部分url -->
        <url-pattern>/*</url-pattern>
    </filter-mapping>
</web-app>

spring配置

<?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:context="http://www.springframework.org/schema/context"
       xmlns:mvc="http://www.springframework.org/schema/mvc"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
        http://www.springframework.org/schema/beans/spring-beans.xsd
        http://www.springframework.org/schema/context
        http://www.springframework.org/schema/context/spring-context.xsd
        http://www.springframework.org/schema/mvc
        http://www.springframework.org/schema/mvc/spring-mvc.xsd">

    <!-- 自动扫描包，让指定包下的注解生效，由IOC容器统一管理（com.yun.controller是我在src/main/java下创建的包） -->
    <context:component-scan base-package="com.yun.controller"/>

    <!-- 让SpringMVC不处理静态资源，如css、js、html、mp3等 -->
    <mvc:default-servlet-handler/>

    <!-- 支持mvc注解驱动：可以直接写<mvc:annotation-driven/>，这样也能工作 -->
    <mvc:annotation-driven>
        <!-- 如果使用了Fastjson，可以用以下配置解决乱码问题 -->
        <mvc:message-converters>
            <bean class="org.springframework.http.converter.StringHttpMessageConverter">
                <constructor-arg value="UTF-8"/>
            </bean>
            <bean class="org.springframework.http.converter.json.MappingJackson2HttpMessageConverter">
                <property name="objectMapper">
                    <bean class="org.springframework.http.converter.json.Jackson2ObjectMapperFactoryBean">
                        <property name="failOnEmptyBeans" value="false"/>
                    </bean>
                </property>
            </bean>
        </mvc:message-converters>
    </mvc:annotation-driven>

    <!-- 视图解析器 -->
    <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver" id="internalResourceViewResolver">
        <!-- 前缀：这里需要手动在WEB-INF下创建一个jsp的目录，jsp是自定义的，不是默认存在的 -->
        <property name="prefix" value="/WEB-INF/jsp/"/>
        <!-- 后缀 -->
        <property name="suffix" value=".jsp"/>
    </bean>

</beans>

1. Hello world

一个最简单的Hello world，至少需要两个注解：@Controller和@RequestMapping。@Controller是类级别的注解，用来表名一个类是Controller，@RequestMapping在类和方法上都可以用，用来指定请求路径，@RequestMapping默认允许所有请求方法GET、PUT等，但是可以使用@GetMapping、@PostMapping、@PutMapping、@DeleteMapping，指定该url只能使用特定的请求方法（GET/POST/PUT/DELETE）进行访问。

package com.yun.controller;

import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.*;

@Controller
// 配置url前缀
@RequestMapping("/hello")
public class HelloController {

    // localhost:8080/hello/zhangsan，如果没有在类级别上配置@RequestMapping("/hello")，
    // 则会直接访问localhost:8080/zhangsan
    @RequestMapping("/zhangsan")
    public String hello(Model model){
        model.addAttribute("msg", "hello, SpringMVCAnnotation!");

        // 只需要返回jsp名称即可，它会自动被视图解析器InternalResourceViewResolver处理，
        // 会自动按照spring中配置好的前缀和后缀规则找到/WEB-INF/jsp/hello.jsp文件
        return "hello";
    }
}

2. URL路径参数

path参数需要配合注解@PathVariable一起使用。

package com.yun.controller;

import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.*;

@Controller
@RequestMapping("/hello")
public class HelloController {
    /*
    如果想要使用path路径参数，可以在url中用{arg}指定参数名称，
    并在方法中按顺序定义对应的名称的参数，但是注意，
    参数名称需要加上@PathVariable注解，而且Model参数放在最后。
     */
    @DeleteMapping("/lisi/{a}/{b}")
    public String test(@PathVariable int a, @PathVariable String b, Model model){
        return "test";
    }
}

4. 请求参数

对于URL中的请求参数，有两种处理方式，一种是使用注解@RequestParam指定对应的参数，另一种是将请求参数封装到一个对象中，定义参数时直接定义对应的对象类型即可。

package com.yun.controller;

import com.yun.pojo.User;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;

@Controller
@RequestMapping("/user")
public class UserController {

    /*
    第一种处理方式：可以给controller方法参数加上注解@RequestParam("name")，表明url中
    必须包含请求参数“name”，然后传入的这个参数将会赋值给对应的被注解的controller方法参数。
    如果请求参数和方法参数一致，也可以不用这个注解，但是无论请求参数名称和controller方法参数名称是否一致，
    都推荐使用这种方式，因为这种方式可读性更高，一看就知道这是url中传入的请求参数，并且可以和url形成一个约定。
     */
    @RequestMapping("/test1")
    public String test1(@RequestParam("name") String name, Model model) {
        model.addAttribute("name", name);
        return "user";
    }

    /*
    第二种处理方式：通过对象传递请求参数
    比如访问url：localhost:8080/user/test2?id=1&name=zhangsan&age=18，
    这种方式要求controller方法的对象参数中的属性字段名称与请求参数名称一致，
    否则无法匹配，无法匹配的字段它的值为null。
     */
    @RequestMapping("/test2")
    public String test2(User user) {
        System.out.println(user);
        return "user";
    }
}

5. 转发和重定向

转发就是正常的返回视图名称，重定向只需要在返回的视图名称字符串前加上前缀 redirect: 即可。

package com.yun.controller;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;

@Controller
public class TestController {

    @RequestMapping("/test/test1")
    public String test1() {
        // 转发：正常返回视图名称
        return "test1";
    }

    @RequestMapping("/test/test2")
    public String test2() {
        // 重定向：在要重定向的视图名称前加上“redirect:”
        return "redirect:test1";
    }
}

6. Controller返回Jason字符串

实际开发中，前端和后端大多时候是分开处理的，后端只需要返回数据给前端，前端拿到数据之后自己展示和渲染界面即可，而返回给前端的数据常用的是Jason字符串格式。SpringMVC中Controller默认返回的字符串是视图名称，即jsp文件名称，可以使用注解@ResponseBody让Controller直接把字符串当做数据直接返回给前端。

/*
如果不想返回的字符串被解析为jsp文件名，那就可以使用@ResponseBody，
此时返回的字符串会被直接返回，可以使用这种方式来返回JSON字符串
 */
@RequestMapping("/test3")
@ResponseBody
public String test3() {
	return "{1:2,3:4}";
}