Controller(控制器)和RestFul风格

Controller

  • 控制器复杂提供访问应用程序的行为,通常通过接口定义注解定义两种方法实现
  • 控制器负责解析用户的请求并将其转换为一个模型(M)
  • 在Spring MVC中一个控制器类可以包含多个方法
  • 在Spring MVC中,对于Controller的配置方式有很多种

实现Controller接口

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

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

说明:

  • 实现接口Controller定义控制器是较老的办法
  • 缺点是:一个控制器中只有一个方法,如果要多个方法则需要定义多个Controller;定义的方式比较麻烦;
  • 相关例子见博客Hello SpringMVC 的XML方式:

使用注解@Controller

  • @Controller注解类型用于声明Spring类的实例是一个控制器;

    在讲IOC时还提到了另外3个注解:

    • @Component 通用注释
    • @Service 表明该类定义了一个数据存储库。
    • @Repository 表明它持有业务逻辑
  • Spring可以使用扫描机制来找到应用程序中所有基于注解的控制器类,为了保证Spring能找到你的控制器,需要在配置文件中声明组件扫描。

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

增加一个ControllerTest2类,使用注解实现,见博客Hello SpringMVC 的注解方式:;

注解方式是平时使用的最多的方式!

RequestMapping

@RequestMapping

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

  • 默认有value属性(或path)

    只注解在方法上

    @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 , 需要先指定类的路径再指定方法的路径;

  • method属性

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

    例如:

    @RequestMapping(value = "/hello",method = {RequestMethod.POST})
    @RequestMapping(value = "/hello",method = {RequestMethod.GET})
    ...
    

    所有的地址栏请求默认都会是 HTTP GET 类型的

  • 组合注解

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

    @GetMapping
    @PostMapping
    @PutMapping
    @DeleteMapping
    @PatchMapping
    

    @GetMapping 等同于 @RequestMapping(method =RequestMethod.GET)

    RestFul 风格

    概念

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

    功能

    资源:互联网所有的事物都可以被抽象为资源

    资源操作:使用POST、DELETE、PUT、GET,使用不同方法对资源进行操作。

    分别对应 添加、 删除、修改、查询。

    传统方式操作资源 :通过不同的参数来实现不同的效果!方法单一,post 和 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

测试用例:

在新建一个类RestFulController

package com.my.controller;

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

/**
 * @ClassName RestFulController
 * @Description
 * @Author huhongsong
 * @Date 2021/7/9 19:13
 * @Version 1.0
 */
@Controller
public class RestFulController {
    //映射访问路径
    @RequestMapping("/add/{p1}/{p2}")
    public String test(@PathVariable int p1, @PathVariable int p2, Model model){
        int i = p1 + p2;
        //Spring MVC会自动实例化一个Model对象用于向视图中传值
        model.addAttribute("msg","结果为"+i);
        //返回视图位置
        return "restful";
    }
}

使用 @PathVariable 注解,让方法参数的值对应绑定到一个URI模板变量上
@RequestMapping("/commit/{p1}/{p2}")中用{}来传参

结果:

Controller(控制器)和RestFul风格

使用路径变量的好处?

  • 使路径变得更加简洁
  • 获得参数更加方便,框架会自动进行类型转换
  • 通过路径变量的类型可以约束访问参数,如果类型不一样,则访问不到对应的请求方法,如这里访问是的路径是/commit/1/a,则路径与方法不匹配,而不会是参数转换失败
上一篇:Spring Boot 接收参数类型


下一篇:Controller中获取输入参数注解使用总结