SpringMVC05：RestFul和控制器

RestFul和控制器

控制器Controller

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

实现Controller接口

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

package org.springframework.web.servlet.mvc;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.springframework.lang.Nullable;
import org.springframework.web.servlet.ModelAndView;

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

}

测试

新建一个Moudle,springmvc-04-controller。将springmvc-03-annotation拷贝一份。
- 删掉HelloController
- springmvc-servlet.xml配置文件中只留下视图解析器

编写一个Controller类，ControllerTest1

package com.edgar.controller;


import org.springframework.web.servlet.ModelAndView;
import org.springframework.web.servlet.mvc.Controller;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

// 只要实现了 Controller 接口的类，说明这是一个控制器了
public class ControllerTest1 implements Controller {
    @Override
    public ModelAndView handleRequest(HttpServletRequest request, HttpServletResponse response) throws Exception {
        ModelAndView mv = new ModelAndView();
        mv.addObject("msg","ControllerTest1");
        mv.setViewName("test");
        return mv;
    }
}

编写完毕后，去springmvc-servlet.xml文件中注册请求的bean；name对应请求路径，class对应处理请求的类
```
<bean name="/t1" class="com.edgar.controller.ControllerTest1"/>
```

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

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

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

说明：

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

使用注解@Controller

@Controller注解类型用于声明Spring类的实例是一个控制器（在讲IOC时还提到了另外3个注解）；
Spring可以使用扫描机制来找到应用程序中所有基于注解的控制器类，为了保证Spring能找到你的控制器，需要在配置文件中声明组件扫描。
```

<context:component-scan base-package="com.edgar.controller"/>
```

增加一个ControllerTest2类，使用注解实现；

package com.edgar.controller;

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

// 被@Controller注解的类，代表这个类被Spring接管，这个类中的所有方法，如果返回值是String，并且有具体页面可以跳转，那么就会被视图解析器解析；
@Controller
public class ControllerTest2 {
	// 映射访问路径
    @RequestMapping("/t2")
    public String test1(Model model) {
        // Spring MVC会自动实例化一个Model对象用于向视图中传值
        model.addAttribute("msg", "ControllerTest2");
         // 返回视图位置
        return "test";
    }

    @RequestMapping("/t3")
    public ModelAndView test1(ModelAndView mv) {
        mv.addObject("msg","test3");
        mv.setViewName("test");
        return mv;
    }
}

运行tomcat测试

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

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

RequestMapping

@RequestMapping

@RequestMapping注解用于映射url到控制器类或一个特定的处理程序方法。可用于类或方法上。用于类上，表示类中的所有响应请求的方法都是以该地址作为父路径。
为了测试结论更加准确，我们可以加上一个项目名测试 myweb

只注解在方法上面

package com.edgar.controller;

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

@Controller
public class ControllerTest3 {

    @RequestMapping("t1")
    public String test1(Model model){
        model.addAttribute("msg","ControllerTest3");
        return "test";
    }
}

访问路径：http://localhost:8080/myweb/t1

同时注解类与方法

package com.edgar.controller;

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

@Controller
@RequestMapping("/c3")
public class ControllerTest3 {

    @RequestMapping("/t1")
    public String test1(Model model){
        model.addAttribute("msg","ControllerTest3");
        return "test";
    }
}

访问路径：http://localhost:8080/myweb/c3/t1 , 需要先指定类的路径再指定方法的路径；

RestFul风格

概念

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

功能

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

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

分别对应:

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

@Controller
public class RestFulController {
}

在Spring MVC中可以i使用 @PathVariable 注解，让方法参数的值对应绑定到一个URL模板变量上。

package com.edgar.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;
import org.springframework.web.bind.annotation.RequestMethod;

@Controller
public class RestFulController {
	// 映射访问路径
    // 原来的 ： http://localhost:8080/add?a=1&b=2
    // RestFul ： http://localhost:8080/add/a/b
    @RequestMapping(value = "/add/{a}/{b}", method = RequestMethod.GET)
    public String test1(@PathVariable int a, @PathVariable int b, Model model) {
        int res = a + b;
        // Spring MVC会自动实例化一个Model对象用于向视图中传值
        model.addAttribute("msg", "结果1为" + res);
        // 返回视图位置
        return "test";
    }
}

我们来测试请求看下
思考：使用路径变量的好处？
- 是路径变得更加简洁
- 获得参数更加方便，框架会自动进行类型转换
- 隐藏了参数名，更加安全
- 通过路径变量的类型可以约束访问参数，如果类型不一样，则访问不到对应的请求方法，如这里访问的路径是/add/1/a，则路径方法不匹配，而不会是参数转换失败

我们来修改下对应的参数类型，再次测试

// 映射访问路径（value或path）
@RequestMapping(value = "/add/{a}/{b}", method = RequestMethod.GET)
public String test1(@PathVariable int a, @PathVariable String b, Model model) {
    String res = a + b;
    // Spring MVC会自动实例化一个Model对象用于向视图中传值
    model.addAttribute("msg", "结果1为" + res);
    // 返回视图位置
    return "test";
}

使用method属性指定请求类型

用于约束请求的类型，可以收窄请求范围。可以指定的请求类型：

GET, HEAD, POST, PUT, PATCH, DELETE, OPTIONS, TRACE

1，GET
安全、幂等；
用于获取资源；

2，HEAD
安全、幂等；
与get方法类似，但不返回message body内容，仅仅是获得获取资源的部分信息（content-type、content-length）；
restful框架中较少使用

3，POST
非安全、非幂等；
用于创建子资源

4，PUT
非安全、幂等；
用于创建、更新资源；

5，DELETE
非安全、幂等；
删除资源；

6，OPTIONS
安全、幂等；
用于url验证，验证接口服务是否正常；

7，TRACE
安全、幂等；
维基百科“回显服务器收到的请求，这样客户端可以看到（如果有）哪一些改变或者添加已经被中间服务器实现。”
restful框架中较少使用

8，PATCH
非安全、幂等；
用于创建、更新资源，于PUT类似，区别在于PATCH代表部分更新；
后来提出的接口方法，使用时可能去要验证客户端和服务端是否支持；

我们来测试一下：

修改上面的一个方法

// 映射访问路径（value或path）
@RequestMapping(value = "/add/{a}/{b}", method = RequestMethod.POST)
public String test1(@PathVariable int a, @PathVariable String b, Model model) {
    String res = a + b;
    // Spring MVC会自动实例化一个Model对象用于向视图中传值
    model.addAttribute("msg", "结果1为" + res);
    // 返回视图位置
    return "test";
}

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

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

// 映射访问路径（value或path）
@RequestMapping(value = "/add/{a}/{b}", method = RequestMethod.GET)
public String test1(@PathVariable int a, @PathVariable String b, Model model) {
    String res = a + b;
    // Spring MVC会自动实例化一个Model对象用于向视图中传值
    model.addAttribute("msg", "结果1为" + res);
    // 返回视图位置
    return "test";
}

小结

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

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

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

@PostMapping
@DeleteMapping
@PutMapping
@GetMapping
@PatchMapping

@GetMapping 是一个组合注解，平时使用的会比较多！

它所扮演的是 @RequestMapping(method =RequestMethod.GET) 的一个快捷方式。

@GetMapping("/add/{a}/{b}")
public String test2(@PathVariable int a, @PathVariable String b, Model model) {
    String res = a + b;
    model.addAttribute("msg", "结果2为" + res);
    return "test";
}

等价于

@RequestMapping(value = "/add/{a}/{b}", method = RequestMethod.GET)
public String test2(@PathVariable int a, @PathVariable String b, Model model) {
    String res = a + b;
    model.addAttribute("msg", "结果2为" + res);
    return "test";
}

SpringMVC05：RestFul和控制器

posted @ 2021-07-20 22:18 EdgarStudy 阅读(57) 评论(0) 编辑收藏举报

刷新页面返回顶部

EdgarStudy

SpringMVC05：RestFul和控制器

RestFul和控制器

控制器Controller

实现Controller接口

使用注解@Controller

RequestMapping

RestFul风格

概念

功能

学习测试

小结

公告