SpringMVC：Controller配置总结

时间：2023-03-09 03:00:09
SpringMVC：Controller配置总结

西部开源-秦疆老师：SpringMVC系列博客 ， 秦老师交流Q群号： 664386224

未授权禁止转载！编辑不易 ， 转发请注明出处！防君子不防小人，共勉！

SpringMVC：Controller配置总结

控制器Controller

控制器复杂提供访问应用程序的行为，通常通过接口定义或注解定义两种方法实现。 控制器负责解析用户的请求并将其转换为一个模型。在Spring MVC中一个控制器类可以包含多个方法；

在SpringMVC中，对于Controller的配置方式有很多种；

控制器实现方式：实现Controller接口

Controller是一个接口，在org.springframework.web.servlet.mvc包下，接口中只有一个方法；

//实现该接口的类获得控制器功能
public interface Controller {
    //处理请求且返回一个模型与视图对象
    ModelAndView handleRequest(HttpServletRequest var1, HttpServletResponse var2) throws Exception;
}

1.新建一个Maven的Web项目，导入相应jar包，保险起见，同之前一样，也需要处理资源过滤问题！

2.配置web.xml 中的 DispatcherServlet ，同之前一样

3.配置springmvc-servlet.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: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-4.3.xsd
        http://www.springframework.org/schema/mvc
        http://www.springframework.org/schema/mvc/spring-mvc-4.3.xsd">

    <!--=======SpringMVC_Start=======-->
    <!-- 视图解析器 -->
    <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver"
          id="internalResourceViewResolver">
        <!-- 前缀 -->
        <property name="prefix" value="/WEB-INF/jsp/" />
        <!-- 后缀 -->
        <property name="suffix" value=".jsp" />
    </bean>
    <!--=======SpringMVC_END=======-->

</beans>

 4.编写一个Controller类

注意点：不要导错包，实现Controller接口，重写方法；

//定义控制器
public class Test1Controller implements Controller {
    @Override
    public ModelAndView handleRequest(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse) throws Exception {
        //返回一个模型视图对象
        ModelAndView mv = new ModelAndView();
        mv.addObject("msg","Test1Controller");
        mv.setViewName("test");
        return mv;
    }
}

编写完毕后，去Spring配置文件中注册请求的bean；name对应请求路径，class对应处理请求的类

<bean name="/233" class="com.kuang.controller.Test1Controller"/>

 5.编写前端test.jsp，注意在WEB-INF/jsp目录下编写，对应我们的视图解析器

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>Kuangshen</title>
</head>
<body>
${msg}
</body>
</html>

 6.配置Tomcat运行测试，我这里没有项目发布名配置的就是一个 / ，所以请求不用加项目名，OK！

SpringMVC：Controller配置总结

实现接口Controller定义控制器是较老的办法，缺点是：一个控制器中只有一个方法，如果要多个方法则需要定义多个Controller；定义的方式比较麻烦；

使用注解@Controller定义控制器

@Controller注解类型用于声明Spring类的实例是一个控制器（在讲IOC时还提到了另外3个注解）；

Spring可以使用扫描机制来找到应用程序中所有基于注解的控制器类，为了保证Spring能找到你的控制器，需要在配置文件中声明组件扫描。

<!-- 自动扫描指定的包，下面所有注解类交给IOC容器管理 -->
<context:component-scan base-package="com.kuang.controller"/>

修改我们的TestController类，使用注解实现；

//@Controller注解的类会自动添加到Spring上下文中
@Controller
public class Test1Controller{

    //映射访问路径
    @RequestMapping("/233")
    public String index(Model model){
        //Spring MVC会自动实例化一个Model对象用于向视图中传值
        model.addAttribute("msg", "注解");
        //返回视图位置
        return "test";
    }
}

运行tomcat测试

SpringMVC：Controller配置总结

可以发现，我们的两个请求都可以指向一个视图，但是页面结果的结果是不一样的，从这里可以看出视图是被复用的，而控制器与视图之间是弱偶合关系。

@RequestMapping

@RequestMapping注释用于映射url到控制器类或一个特定的处理程序方法。可用于类或方法上。用于类上，表示类中的所有响应请求的方法都是以该地址作为父路径。

只注解在方法上面

@Controller
public class TestController {
    @RequestMapping("/h1")
    public String test(){
        return "test";
    }
}

访问路径：http://localhost:8080/项目名/h1

同时注解类与方法

@Controller
@RequestMapping("/admin")
public class TestController {
    @RequestMapping("/h1")
    public String test(){
        return "test";
    }
}

访问路径：http://localhost:8080/项目名/admin/h1  , 需要先指定类的路径再指定方法的路径；

Restful风格

概念
Restful就是一个资源定位及资源操作的风格。不是标准也不是协议，只是一种风格。基于这个风格设计的软件可以更简洁，更有层次，更易于实现缓存等机制。

功能
资源：互联网所有的事物都可以被抽象为资源
资源操作：使用POST、DELETE、PUT、GET，使用不同方法对资源进行操作。
分别对应 添加、 删除、修改、查询。
传统方式操作资源
http://127.0.0.1/item/queryItem.action?id=1 查询,GET
http://127.0.0.1/item/saveItem.action 新增,POST
http://127.0.0.1/item/updateItem.action 更新,POST
http://127.0.0.1/item/deleteItem.action?id=1 删除,GET或POST

使用RESTful操作资源
http://127.0.0.1/item/1 查询,GET
http://127.0.0.1/item 新增,POST
http://127.0.0.1/item 更新,PUT
http://127.0.0.1/item/1 删除,DELETE

在Spring MVC可以使用@PathVariable 注释方法参数的值对应绑定到一个URI模板变量上。

@Controller
public class Test1Controller{

    //映射访问路径
    @RequestMapping("/commit/{p1}/{p2}")
    public String index(@PathVariable int p1,@PathVariable int p2, Model model){
        //Spring MVC会自动实例化一个Model对象用于向视图中传值
        model.addAttribute("msg", p1+p2);
        //返回视图位置
        return "test";
    }
}

我们请求查看下

SpringMVC：Controller配置总结

使用路径变量的好处：使路径变得更加简洁；获得参数更加方便，框架会自动进行类型转换。通过路径变量的类型可以约束访问参数，如果类型不一样，则访问不到对应的请求方法，如这里访问是的路径是/commit/1/a，则路径与方法不匹配，而不会是参数转换失败。

SpringMVC：Controller配置总结

我们来修改下对应的参数类型

    //映射访问路径
    @RequestMapping("/commit/{p1}/{p2}")
    public String index(@PathVariable int p1,@PathVariable String p2, Model model){
        //Spring MVC会自动实例化一个Model对象用于向视图中传值
        model.addAttribute("msg", p1+p2);
        //返回视图位置
        return "test";
    }

SpringMVC：Controller配置总结

method属性指定请求类型

用于约束请求的类型，可以收窄请求范围。指定请求谓词的类型如GET, POST, HEAD, OPTIONS, PUT, PATCH, DELETE, TRACE等

我们来测试一下：

    //映射访问路径,必须是POST请求
    @RequestMapping(value = "/commit",method = {RequestMethod.POST})
    public String index(Model model){
        //Spring MVC会自动实例化一个Model对象用于向视图中传值
        model.addAttribute("msg", "commit");
        //返回视图位置
        return "test";
    }

我们使用浏览器地址栏进行访问默认是Get请求，会报错405：

SpringMVC：Controller配置总结

如果将POST修改为GET则正常了；

    //映射访问路径,必须是POST请求
    @RequestMapping(value = "/commit",method = {RequestMethod.GET})
    public String index(Model model){
        //Spring MVC会自动实例化一个Model对象用于向视图中传值
        model.addAttribute("msg", "commit");
        //返回视图位置
        return "test";
    }

访问:

SpringMVC：Controller配置总结

Spring MVC 的 @RequestMapping 注解能够处理 HTTP 请求的方法, 比如 GET, PUT, POST, DELETE 以及 PATCH。

所有的请求默认都会是 HTTP GET 类型的。

方法级别的注解变体有如下几个：

@GetMapping
@PostMapping
@PutMapping
@DeleteMapping
@PatchMappin

@GetMapping 是一个组合注解，它所扮演的是 @RequestMapping(method =RequestMethod.GET) 的一个快捷方式。

彩蛋：小黄鸭调试法

场景一：我们都有过向别人（甚至可能向完全不会编程的人）提问及解释编程问题的经历，但是很多时候就在我们解释的过程中自己却想到了问题的解决方案，然后对方却一脸茫然。

场景二：你的同行跑来问你一个问题，但是当他自己把问题说完，或说到一半的时候就想出答案走了，留下一脸茫然的你。

其实上面两种场景现象就是所谓的小黄鸭调试法（Rubber Duck Debuging），又称橡皮鸭调试法，它是我们软件工程中最常使用调试方法之一。

SpringMVC：Controller配置总结

此概念据说来自《程序员修炼之道》书中的一个故事，传说程序大师随身携带一只小黄鸭，在调试代码的时候会在桌上放上这只小黄鸭，然后详细地向鸭子解释每行代码，然后很快就将问题定位修复了。

我们还可以看看其他两种Controller配置方式，虽然不推荐使用，可以加深了解

URL对应Bean

使用这个方式可以省去一些Spring注解；

我们编写我们的Controller，写两个请求；

public class Test1Controller{

    //映射访问路径
    @RequestMapping(value = "/commit")
    public String index(Model model){
        //Spring MVC会自动实例化一个Model对象用于向视图中传值
        model.addAttribute("msg", "commit");
        //返回视图位置
        return "test";
    }

    //映射访问路径
    @RequestMapping(value = "/commit2")
    public String index2(Model model){
        //Spring MVC会自动实例化一个Model对象用于向视图中传值
        model.addAttribute("msg", "commit2");
        //返回视图位置
        return "test";
    }

}

我们去Spring配置文件中，注册对应的bean，id为请求的路径，需要与映射请求的路径相同

<?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-4.3.xsd
        http://www.springframework.org/schema/mvc
        http://www.springframework.org/schema/mvc/spring-mvc-4.3.xsd">

    <!-- 视图解析器 -->
    <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver"
          id="internalResourceViewResolver">
        <!-- 前缀 -->
        <property name="prefix" value="/WEB-INF/jsp/" />
        <!-- 后缀 -->
        <property name="suffix" value=".jsp" />
    </bean>

    <!--配置HandlerMapping-->
    <bean class="org.springframework.web.servlet.handler.BeanNameUrlHandlerMapping"/>
    <!--配置请求和处理器-->
    <bean name="/commit" class="com.kuang.controller.Test1Controller"/>
    <bean name="/commit2" class="com.kuang.controller.Test1Controller"/>

</beans>

注 : 按照以上方式配置 , 访问/commit就会寻找id为 "/commit" 的bean . commit2，就会找commit2的bean，此类方式适合小型系统 .

SpringMVC：Controller配置总结

SpringMVC：Controller配置总结

在讲解一种方式

为URL分配Bean

使用一个统一的配置集合 , 对各个URL对应的Controller做关系映射 .

    <bean class="org.springframework.web.servlet.handler.SimpleUrlHandlerMapping">
        <property name="mappings">
            <props>
                <prop key="/test">test1Controller</prop>
            </props>
        </property>
    </bean>
    <bean id="test1Controller" class="com.kuang.controller.Test1Controller"/>

对应的java类

public class Test1Controller implements Controller {
    @Override
    public ModelAndView handleRequest(HttpServletRequest req, HttpServletResponse rsp) throws Exception {
        ModelAndView mv = new ModelAndView();
        mv.addObject("msg","Test1Controller");
        mv.setViewName("test");
        return mv;
    }
}

测试OK:

SpringMVC：Controller配置总结

上面的控制器配置，一般情况下我们都是用注解去完成路径映射，配置十分方便，其余的了解即可！

相关文章