SpringMVC-03-RestFul和Controller

1、Controller

  • MVC架构中的控制层,在SpringMVC中,由 Handler 组成
  • 负责提供访问应用程序的行为:处理用户的请求并调用 Model层 将其转换为一个模型数据跳向 View层
  • 在Spring MVC中,对于Controller的配置方式有很多种,通常可以通过接口定义注解定义两种方法实现

新建一个子项目,SpringMVC-04-Controller,搭建好项目

  • spring-mvc.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"
 xsi:schemaLocation="
 http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
 http://www.springframework.org/schema/context https://www.springframework.org/schema/context/spring-context.xsd
">
 
 <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">
 <property name="prefix" value="/WEB-INF/jsp/"/>
 <property name="suffix" value=".jsp"/>
 </bean>
 
</beans>
  • 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">
 <servlet>
 <servlet-name>DispatcherServlet</servlet-name>
 <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
 <init-param>
 <param-name>contextConfigLocation</param-name>
 <param-value>classpath:spring-mvc.xml</param-value>
 </init-param>
 <load-on-startup>1</load-on-startup>
 </servlet>
 <servlet-mapping>
 <servlet-name>DispatcherServlet</servlet-name>
 <url-pattern>/</url-pattern>
 </servlet-mapping>
</web-app>
  • test.jsp
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
 <title>test</title>
</head>
<body>
${msg}
</body>
</html>

1.1、实现Controller接口

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

// 实现该接口的类获得Controller功能
public interface Controller {
 // 处理请求且返回一个 ModelAndView 对象
 ModelAndView handleRequest(HttpServletRequest request, HttpServletResponse response) throws Exception;
}

新建 ControllerTest 类,实现 Controller 接口

package com.moondream.controller;
import org.springframework.web.servlet.ModelAndView;
import org.springframework.web.servlet.mvc.Controller;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
public class ControllerTest implements Controller {
 
 @Override
 public ModelAndView handleRequest(HttpServletRequest request, HttpServletResponse response) throws Exception {
 ModelAndView mv = new ModelAndView();
 mv.addObject("msg", "ControllerTest");
 mv.setViewName("/test");
 return mv;
 }
}

将 ControllerTest 注册到 SpringIOC 中,id对应请求路径,class对应处理请求的类

<bean id="/t1" class="com.moondream.controller.ControllerTest"/>

启动Tomcat,测试访问路径:http://localhost:8080/spring04/t1

测试成功!

注意:

  • 实现接口Controller定义 Handler 是较老的办法;
  • 缺点:一个类中只有一个请求处理方法,如果要多个Handler则需要定义多个类;定义的方式比较麻烦。

1.2、使用注解@Controller和@RequestMapping

@Controller

  • 用于声明被标注的类属于 Controller层
  • 模板注解,被标注的类会被 component-scan 扫描到

@RequestMapping

  • 用于声明被标注的方法属于 HandlerMethod(注解方式中的Handler)
  • 当它被标注在一个类上时,相当于类下的 HandlerMethod 的前置要求
  • 只有在 被@Controller标注的类 中才会生效

新建 ControllerTest2 类 和 ControllerTest3 类,标上注解

package com.moondream.controller;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.RequestMapping;
@Controller
public class ControllerTest2 {
 @RequestMapping("/t2")
 public String test(Model model) {
 model.addAttribute("msg", "ControllerTest2");
 return "test";
 }
}
package com.moondream.controller;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.RequestMapping;
@Controller
@RequestMapping("/t3")
public class ControllerTest3 {
 @RequestMapping("/test")
 public String test(Model model) {
 model.addAttribute("msg", "ControllerTest3");
 return "test";
 }
}

将 ControllerTest2、ControllerTest3 注册到 SpringIOC中,这里可以使用两种方式

  • 组件扫描
<context:component-scan base-package="com.moondream.controller"/>

或者

  • 手动注册
<bean class="com.moondream.controller.ControllerTest2"/>
<bean class="com.moondream.controller.ControllerTest3"/>

启动Tomcat,测试访问路径:

http://localhost:8080/spring04/t2

http://localhost:8080/spring04/t3/test

测试成功!

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

2、RestFul

2.1、什么是REST ?(一种软件架构风格)

缩写:REST (不是"rest"这个单词)
外文名:Representational State Transfer,简称REST。
中文名:表现层状态转移。
提出时间:2000年。
属性:一种软件架构风格。(以Web为平台的,web服务的架构风格,前后端接口时候用到。)

REST之所以晦涩难懂,是因为前面主语(Resource )被去掉了。
全称是: Resource Representational State Transfer。
通俗来讲就是:资源在网络中以某种表现形式进行状态转移。

分解开来讲解:
Resource:资源,即数据(这是网络的核心);
Representational:某种表现形式,比如用JSON,XML,JPEG等;
State Transfer:状态变化。通过HTTP的动词(get查询、post新增、put修改、delete删除)实现。

一句话描述REST实质:
只使用名词URL来定位资源,用HTTP协议里的动词(GET、POST、PUT、DELETE)来实现资源的增删改查操作。

传统方式操作资源 :通过不同的URL路径和参数来实现不同的效果!方法单一,post 和 get

REST风格操作资源 :参数设计进URL路径,增强语义,实现统一接口,URL表示资源位置,请求方式表示行为,实现不同的效果!如下:请求地址一样,但是功能可以不同!

总结:
看Url就知道要什么
看http method就知道干什么
看http status code就知道结果如何

2.2、什么是RESTFUL ?

从上面的定义中,我们可以发现REST其实是一种组织Web服务的架构风格,
并不是实现Web服务的一种技术(注意:不是一种技术!!!也不是一种标准!!!),
其目标是为了创建具有良好扩展性的网络化分布式系统。

反过来,作为一种风格,其具备了一系列架构级特点。这些特点有:

  1. 统一接口(Uniform Interface):强调使用统一的接口来处理资源,通过 HTTP 方法对资源进行操作(GET 用于获取资源、POST 用于创建资源、PUT 用于更新资源、DELETE 用于删除资源),使得客户端和服务器之间的通信更加简单和统一。
  2. 无状态性(Stateless):服务端不会保存有关客户的任何状态,也就是说,客户端自身负责用户状态的维持,并在每次发送请求时都需要提供足够的信息。这样可以提高系统的可伸缩性和性能,同时降低了服务器端的维护成本。
  3. 可缓存(Cacheable):支持缓存机制,客户端可以缓存服务器返回的资源,以尽量减少服务端和客户端之间的信息传输,在一定条件下可以直接使用缓存减轻服务器的压力,降低网络延迟。
  4. 层次化系统(Layered System):支持客户端和服务器之间的解耦,允许通过添加代理服务器或者缓存改进性能、安全性等方面,客户端并不会固定地与一个服务器打交道。
  5. 自描述消息(Self-descriptive Messages):要求使用标准化的媒体类型(MIME类型)来传递消息,例如 JSON、XML,使得消息能够自解释,减少了通信的复杂性。

如果一个系统满足了上面所列出的五条特点,那么该系统就被称为是RESTfUL的。

2.3、REST风格好处

前后端分离

前端拿到数据只负责展示和渲染,不对数据做任何处理。
后端处理数据并以JSON格式传输出去,定义这样一套统一的接口,在web,ios,android三端都可以用相同的接口,达成复用(因为不需要写三次代码,一次代码可以公用给三端;另外,修改代码只要修改一次,三端都同步访问新代码,不需要修改三次代码。)

2.4、REST风格缺点

无状态约束,正是它的一个缺点。
其需要在每次请求中包含所有必要信息,来维持客户端状态,扩大了数据传输量,增大了网络传输压力。

2.5、案例测试

在项目下新建一个Java类 RestFulController

package com.moondream.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
@RequestMapping("/t4")
public class RestFulController {
 @RequestMapping(value = "/{p1}/{p2}",method = RequestMethod.GET)
 public String add(@PathVariable Integer p1, @PathVariable Integer p2, Model model) {
 int res = p1 + p2;
 model.addAttribute("msg", "相加结果为:" + res);
 return "test";
 }
 @RequestMapping(value = "/{p1}/{p2}",method = RequestMethod.POST)
 public String subtract(@PathVariable Integer p1, @PathVariable Integer p2, Model model) {
 int res = p1 - p2;
 model.addAttribute("msg", "相减结果为:" + res);
 return "test";
 }
 
}

代码解释:

  • @PathVariable :顾名思义,路径变量,只能标注在方法参数上。其实就是改变了Spring框架对方法参数进行数据绑定的方式
    普通方法参数进行数据绑定:request.getParameter("参数名")
    @PathVariable方法参数进行数据绑定:格式化请求路径得来。格式化模板:/{参数名1}/{参数名2}……
    使用@PathVariable注解,将参数写入路径当中,更符合Rest风格

修改 test.jsp

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
 <title>test</title>
</head>
<body>
${msg}
<form action="http://localhost:8080/spring04/t4/1/2" method="post">
 <input type="submit"/>
</form>
</body>
</html>

代码解释:

  新增一个表单,以post方式发起请求,与get请求做区别,指向同一个URL。

启动Tomcat,访问测试路径:http://localhost:8080/spring04/t4/1/2

如图,http://localhost:8080/spring04/t4/1/2 URL为特定资源位置,Get和Post两种请求方法为 访问行为,分别代表 相加 和 相减。
使用Get请求访问资源,得到相加结果为3,使用Post请求访问资源,得到相减结果为-1。
这种将 ”行为“ 从URL中抽离出来,用Http动词代替,URL只表示纯粹的资源位置的web设计,符合Rest风格,是RestFul的。

3、补充

对于@RequestMapping,有一些组合注解:

@GetMapping
@PostMapping
@PutMapping
@DeleteMapping
@PatchMapping

这些注解相当于指定了method属性的@RequestMapping,是特定method@RequestMapping的快捷方式,详细的可以去看看源码,很简单,这里不细说了。


每个程序员都要知道的:小黄鸭调试法

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

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

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

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

这其实就是典型的 费曼学习法,借助向别人输出知识,来印证自身所学和总结经验。
写博客其实也是一样的哦!


参考文章
https://blog.csdn.net/SeniorShen/article/details/111591122
https://www.zhihu.com/question/28557115

作者:MoonDreamV原文地址:https://www.cnblogs.com/blog-moondream/p/18290391

%s 个评论

要回复文章请先登录注册