SpringMVC注解的使用

最新推荐文章于 2024-07-24 12:11:49 发布

归途to

最新推荐文章于 2024-07-24 12:11:49 发布

阅读量534

点赞数

分类专栏： Spring 文章标签： spring mvc java

本文链接：https://blog.csdn.net/qq_45775027/article/details/120241257

版权

Spring 专栏收录该内容

12 篇文章 0 订阅

订阅专栏

文章目录

背景：传统风格的控制器是由实现 Controller 接口的类编写的。这种控制器不仅需要在配置文件中部署映射，而且只能编写一个处理方法，不够灵活。Spring 2.5 版本新增了 Spring MVC 注解功能，用于替换传统的基于 XML 的 Spring MVC 配置。

注解的优点：

在基于注解的控制器类中可以编写多个处理方法，进而可以处理多个请求（动作），这就允许将相关的操作编写在同一个控制器类中，从而减少控制器类的数量，方便以后维护。
基于注解的控制器不需要在配置文件中部署映射，仅需要使用 @RequestMapping 注解一个方法进行请求处理即可。

控制器中最主要的两个注解 @Controller 和 @RequestMapping

Controller

@Controller 注解用于声明某类的实例是一个控制器。

import org.springframework.stereotype.Controller;
@Controller
public class HelloController {
    // 这里面编写处理请求的方法
}

并且，Spring MVC 是通过扫描机制找到包中所有基于注解的控制器类，所以，我们必须在配置文件中声明 spring-context，使用 <context:component-scan base-package="包名"/>让控制器类被 Spring MVC 框架扫描到。

RequestMapping

使用注解后一个控制器内有多个处理请求的方法，如 UserController 里通常有增加用户、修改用户信息、删除用户等。每个方法负责不同的请求操作，而 @RequestMapping 就负责将请求映射到对应的控制器方法上。

@RequestMapping 注解可用于类或方法上。用于类上，表示类中的所有响应请求的方法都以该地址作为父路径。

RequestMapping属性详解

value

value 属性是 @RequestMapping 注解的默认属性，因此如果只有 value 属性时，可以省略该属性名，如果有其它属性，则必须写上 value 属性名称。

@RequestMapping(value="user")
@RequestMapping("user")

value 属性支持通配符匹配，如 @RequestMapping(value=“toUser/*”) 表示能够访问http://localhost:8080/toUser/xxx 下的所有资源。

path

path 属性和 value 属性都用来作为映射使用。即 @RequestMapping(value=“user”) 和 @RequestMapping(path=“user”) 都能访问 User() 方法，而且path同样支持通配符匹配。

name

name属性相当于方法的注释，使方法更易理解。如 @RequestMapping(value = “getUser”,name = “获取用户信息”)。

method

method 属性用于表示该方法支持哪些 HTTP 请求。如果省略 method 属性，则说明该方法支持全部的 HTTP 请求。

@RequestMapping(value = "user",method = RequestMethod.GET) 表示该方法只支持 GET 请求。也可指定多个 HTTP 请求，如 @RequestMapping(value = "user",method = {RequestMethod.GET,RequestMethod.POST})，说明该方法同时支持 GET 和 POST 请求。

params

params 属性用于指定请求中规定的参数

@RequestMapping(value = "showUser",params = "type")
public String showUser() {
    return "showUser";
}

请求中必须包含 type 参数时才能执行该请求。即 http://localhost:8080/showUser?type=xxx 能够正常访问 showUser() 方法，而 http://localhost:8080/showUser 则不能正常访问 showUser()方法。

consumers属性

consumers 属性用于指定处理请求的提交内容类型（Content-Type），例如：application/json、text/html。
@RequestMapping(value = "toUser",consumes = "application/json")

produces属性

produces 属性用于指定返回的内容类型，返回的内容类型必须是 request 请求头中所包含的类型。如 @RequestMapping(value = "toUser",produces = "application/json")。

除此之外，produces 属性还可以指定返回值的编码。如 @RequestMapping(value = “toUser”,produces = “application/json,charset=utf-8”)，表示返回 utf-8 编码。

下面用代码演示注解在SpringMVC的具体使用

代码演示

使用Maven创建Web项目导入相关jar包,Web项目相关文件目录如下
在这里插入图片描述
web.xml文件

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="https://jakarta.ee/xml/ns/jakartaee"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="https://jakarta.ee/xml/ns/jakartaee https://jakarta.ee/xml/ns/jakartaee/web-app_5_0.xsd"
         version="5.0">
    <servlet>
        <servlet-name>springmvc</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
<!--        启动级别1-->
        <load-on-startup>1</load-on-startup>
        <init-param>
<!-        指定springmvc配置文件路径-->
            <param-name>contextConfigLocation</param-name>
            <param-value>classpath:springmvc-servlet.xml</param-value>
        </init-param>
    </servlet>
    <servlet-mapping>
        <servlet-name>springmvc</servlet-name>
        <url-pattern>/</url-pattern>
    </servlet-mapping>
</web-app>

springmvc配置文件springmvc-servlet.xml

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:mvc="http://www.springframework.org/schema/mvc"
       xmlns:context="http://www.springframework.org/schema/context"
       xmlns="http://www.springframework.org/schema/beans"
       xsi:schemaLocation="http://www.springframework.org/schema/mvc
        http://www.springframework.org/schema/mvc/spring-mvc-4.2.xsd
        http://www.springframework.org/schema/context
        http://www.springframework.org/schema/context/spring-context-4.2.xsd
        http://www.springframework.org/schema/beans
        http://www.springframework.org/schema/beans/spring-beans-4.2.xsd ">
<!--    自动扫描包，让指定包下的注解生效，由IOC容器统一管理-->
    <context:component-scan base-package="controller"/>
<!--    让SpringMVC不去处理静态资源  .css .js .mp3 .mp4-->
    <mvc:default-servlet-handler/>
<!--    开启注解的支持-->
    <mvc:annotation-driven/>
<!--    视图解析器-->
    <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">
<!--        前缀-->
        <property name="prefix" value="/WEB-INF/jsp/"/>
<!--        后缀-->
        <property name="suffix" value=".jsp"/>
    </bean>
</beans>

创建UserController实体类

import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
//采用类级别的注解，此类上的RequestMapping是类中的所有响应请求的父路径
@Controller
@RequestMapping("/user")
public class UserController {
//value表示请求的URL，method表示请求的方法，这里设置的是get请求，如果是post请求这个方法无法接收这个请求
    @RequestMapping(value = "/login",method = RequestMethod.GET)
    //注解RequestParam表示请求的参数必须含有username和password
    public String Login(@RequestParam String username, @RequestParam String password, Model model){
        String str = null;
        if (username.equals("lsl")&&password.equals("251210")){
            str="成功登录页面";
        }
        else{
            str="账号密码错误，请重新登录";
        }
        model.addAttribute("msg",str);
        return "login";
    }
    @RequestMapping("/register")
    public String Register(){
        return "register";
    }
}

jsp文件较为简略，只做展示使用

index.jsp

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
  <head>
    <title>首页</title>
  </head>
  <body>
  <form method="get" action="${pageContext.request.contextPath}/user/login">
    请输入用户名<input name="username" type="text"/><br/>
    请输入密码<input name="password" type="text"/><br>
    <input type="submit">
  </form>

<a href="${pageContext.request.contextPath}/user/register"  style="text-decoration: none">注册</a>
  </body>
</html>

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

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>注册账户</title>
</head>
<body>
用户名：<input ><br>
密码：<input ><br>
确认密码：<input>
</body>
</html>

运行tomcat服务器，最先跳转到index.jsp页面
在这里插入图片描述
然后输入正确的username和password，点击提交，进入login.jsp页面

登录成功，也可以选择错误的账号和密码

在这里插入图片描述

注：这里进入的还是login.jsp页面，只是msg的信息不同，没有进行复杂的跳转

Restful风格

我们遇到的url格式一般都为https://xxx/xxx/xxx。这就是Restful风格的url。

这是通过PathVariable注解接收请求的参数实现的

如上面的登录代码使用Restful风格编写如下

@RequestMapping(value = "/login/{username}/{password}",method = RequestMethod.GET)
public String Login(@PathVariable String username, @PathVariable String password, Model model){
        String str = null;
        if (username.equals("lsl")&&password.equals("251210")){
            str="成功登录页面";
        }
        else{
            str="账号密码错误，请重新登录";
        }
        model.addAttribute("msg",str);
        return "login";
    }

在访问“http://localhost:8080/user/login/lsl/251210”路径时，上述代码会自动将 URL 中的模板变量 {username} 和 {password} 绑定到通过 @PathVariable 注解的同名参数上，即 username=lsl、pwd=251210。

归途to

关注

0
点赞
踩
1

收藏

觉得还不错? 一键收藏
1
评论
SpringMVC注解的使用

文章目录注解的优点：ControllerRequestMappingRequestMapping属性详解valuepathnamemethodparamsconsumers属性produces属性代码演示背景：传统风格的控制器是由实现 Controller 接口的类编写的。这种控制器不仅需要在配置文件中部署映射，而且只能编写一个处理方法，不够灵活。Spring 2.5 版本新增了 Spring MVC 注解功能，用于替换传统的基于 XML 的 Spring MVC 配置。注解的优点：在基于注解的控制
复制链接

扫一扫

专栏目录