SpringMVC初识--注解的使用

不会敲代码

已于 2023-12-04 22:32:57 修改

阅读量75

点赞数

分类专栏： SSM框架文章标签： spring java 后端

于 2023-11-03 15:57:16 首次发布

本文链接：https://blog.csdn.net/m0_72536301/article/details/134100555

版权

SSM框架专栏收录该内容

6 篇文章 0 订阅

订阅专栏

一. 浅谈Spring

1.1 什么是框架

框架,最早源于建筑行业,是一个框子--指其约束性,也是一个架子--指其支撑性,是一个基本概念上的结构,用于去解决或处理复杂的问题.在计算机行业中,可以看做是为应用开发者量身订做的脚手架.

其实上面的解释说了等于没说~用大白话解释就是,框架能帮助我们程序猿进行高效简单的开发.

就拿包韭菜鸡蛋饺子来举例吧,俺喜欢吃~在Servlet时代,就需要我们买韭菜,洗韭菜,炒鸡蛋,调馅,和面,擀皮,包饺子,煮饺子;如果有了Spring这个框架,就是各种智能家具帮助我们洗菜,炒菜,和面......只要我们按照它们的说明书进行操作,就可以得到一份完美的饺子.

1.2 我们要学哪些框架

接下来的博文中,本人将会介绍Spring,SpringBoot,SpringMVC,MyBatis四个框架.

其中Spring,SpringBoot,SpringMVC都是Spring全家桶的产品.

SpringBoot是基于Spring开发的框架,如果把Spring看作可以帮助包饺子的智能家居的话,SpringBoot就是一个智能机器人,我们只需要输入指令,然后等着吃饺子就可以了.

SpringMVC又称为SpringWeb,是SpringBoot中的Web模块,它的作用就是帮助我们开发Web程序.

MyBatis是一个持久层框架,封装了JDBC的操作,能帮助我们更好地操作数据库.

关于Spring等概念后面还会详细介绍,如果这里不懂也没有关系,我们主打一个"先用后理解"

二. 创建SpringMVC项目

各位童鞋不要疑惑--怎么Spring还没学就要先学SpringMVC了?

因为我们要开发是Web项目,要直接用到SpringBoot,SpringMVC框架,所以先来学习一下MVC框架的使用吧~(在这里标注一下,SpringBoot项目和SpringMVC项目并不是互斥的关系,我们这里创建的既是SpringBoot项目,也是SpringMVC项目,本文主要学习它们的使用,先不做区分)

下面是使用社区版idea创建SpringBoot项目流程(本人的idea是2021.3版本,jdk是8)

2.1 MVC项目的创建

1. 安装Spring Boot Help插件(专业版不需要)

我们先随便创建一个项目,然后进行插件安装.

操作流程见下图

如果诸位从idea应用界面安装不下来,可以点击Plugin homepage进入idea官网选择合适的插件安装.

如上图,选择对应版本后点击DownLoad,然后在idea上进行如下操作,选择压缩包(不要解压!!!)对应的路径即可

重启idea,再次打开Plugin页面,就可以在Installed看到它,只不过变成了下面这个样子

2. 创建SpringBoot项目

按照下图进行操作即可

3. Maven项目加载

打开项目后,我们会看到这样的一个目录,这时候注意看看右下角有没有这样一个提示,表明idea识别到这是一个maven项目,我们点击Load即可

如果不小心把这个提示框叉掉了也没关系,按照下图进行操作,然后点击maven即可

如何查看自己的项目是否加载成功呢?查看src下的DemoApplication类是否变绿,如下图,博主的就爆红了

点开这个类发现注解是标红的,说明没有引入相关依赖

解决办法一: 可能是因为依赖没有完全加载进来,在idea右侧界面找到maven,按照下图进行刷新

然后发现仍然爆红,查看左下角的外部jar包发现没有引入Maven,说明网络不行,试了试配置maven国内源

点击刚才的启动类,可以正常启动说明项目已经加载好了

查看idea控制台的输出,找到上图这句话,表明Tomcat已经启动(Spring框架内置了Tomcat),占用的端口号是8080,项目路由为' '(空)

2.1. MVC目录说明

2.3 运行项目

通过上文,我们已经启动了一个HTTP服务器,但是并未给这个服务器增添任何功能.下面就来实现一下,让这台服务器输出"Hello world"吧.

1. 在启动类所在目录下,或者与启动类同级目录下创建一个HelloCon类.

2. 按照下图给这个类添上方法

@RestController//表示该类的方法返回的是数据,否则默认返回vue视图
public class HelloCon {

    @RequestMapping("/hello")//该方法的路由
    public String sayHello(){
        return "Hello world!";
    }

}

3. 重启这个项目,然后通过浏览器访问127.0.0.1:8080/hello,就会得到服务器的响应了

三. 项目的使用--注解

经过上面一顿猛如虎的操作,是不是感觉SpringWeb用起来很方便!下面来详细讲讲怎样用Spring部署一台Web服务器吧.

3.1 有关http请求的注解

3.1.1 @RequestMapping注册路由

刚刚演示了通过"/hello"路由访问了sayHello方法,实际上就是@RequestMapping注解给sayHello方法注册了一个路由,前端可以通过这个路由访问到这个方法.

下图为@RequestMapping的源码(先对部分属性进行介绍,余下的后文会讲)

@RequestMapping既可以修饰类,也可以修饰方法,通常建议给每个类都注册上一个路由(如果访问某一URL出错,便于我们定位到这个类)
@RequestMapping后面的()内可以直接写上路由,默认是value的值
@RequestMapping的URL可以是多层路径
如果一个类注册了路由,访问该类的方法时的URL应该是/类路由/方法路由
@RequestMapping的URL路径最前面加不加"/"都可,Spring程序启动时检测到没有'/',会自动补上

@RestController
@RequestMapping("hello/con")//给HelloCon类注册一个hello/con路由,最前面可以没有'/'
public class HelloCon {
    @RequestMapping("/hello")
    public String sayHello(){
        return "Hello world!";
    }
}

童鞋们有没有想到一个问题,使用浏览器访问这个方法时是GET请求,那么@RequestMapping支不支持其他类型的请求呢?让我们用postman来模拟一下~

经过尝试发现,用post,delete,put,get等方法都可以获取到"Hello world"响应.那么我们可不可以控制一下前端访问的方法呢?

方法1. 使用@RequestMapping的method属性

需要在@RequestMapping后面的()中指定访问方法

@RestController
public class HelloCon {
    
    @RequestMapping(value = "/hello",method = RequestMethod.GET)//该URL只能通过get方法访问
    public String sayHello(){
        return "Hello world!";
    }
}

再次使用Postman发起get请求,仍然可以得到hello world

但是使用post方法就会报错

方法2. 使用@GetMapping/@PostMapping注解

同一个方法只能使用上面两个的其中一个

@RestController
public class HelloCon {

    @GetMapping("/hello")//表示该路由只支持get请求
    public String sayHello(){
        return "Hello world!";
    }
}

使用postman发起get和post请求,与方法一是一样的效果

3.1.2 接收单个参数

来个简单的复习吧,回顾一下Servlet时代是如何接收请求中的参数的?通过QueryString/form表单发来的请求,使用HttpRequest对象的getParameter()方法进行获取;如果前端传来的是json格式的字符串,需要使用ObjectMapper类进行转换成java对象.(看不懂的uu请自行忽略此段...)

那么SpringWeb项目该如何接收前端传来的参数呢?---很简单,只需要在方法里定义该参数即可

在helloCon类里定义sayHi方法

@RequestMapping("hi")
public String sayHi(String name){
       return name+", Hi!";
}

然后我们使用浏览器进行访问

可以看到,服务器可以获取到QueryString里的参数,如果我们使用form表单的格式进行参数提交呢?

发现同样可以接收form表单的参数(注意:需要使用post方法,否则服务器默认不获取body里的数据)

注意: 定义传递的参数时最好是包装类,如果使用基本数据类型后端容易抛异常

比如要获取一个整型数据

定义获取的参数为int类型

@RequestMapping("/num")
    public String getNum(int num){
        return "获取到的Num为: "+num;
    }

这时候前端传来一个num,得到了正常的响应

但是!!!如果前端没有传递num,服务器就会抛出一大堆异常...

如果我们将参数修改为Integer类型就不会出现这个问题,因为Integer变量的值可以为null

@RequestMapping("/num")
    public String getNum(Integer num){
        return "获取到的Num为: "+num;
    }

3.1.3 接收多个参数 & 后端参数重命名

既然接收一个参数可以直接在方法的形参列表中定义,当我们需要多个参数的时候也可以直接在形参列表中定义

@RequestMapping("/stu")
public String getStu(Integer id,String name){//获取一个学生信息,id和name
     return "学生id: "+id+"<br>"+"学生name: "+name;
}

可以看到,前端传来参数顺序和后端接收顺序无关,只要参数名对应即可.

但往往会出现这样一些情况----前端传来的数据是s1='zhansgan',s2=18,这会让有代码洁癖的后端程序猿一头撞上南墙...

如果我们不想让方法的形参名和前端传来的参数名一致,该怎么解决这种问题呢?

需要使用@RequestParam注解

@RequestMapping("/stu")
public String getStu(@RequestParam("s1") Integer id,@RequestParam("s2") String name){//id对应前端传来的s1,name对应前端传来的s2
    return "学生id: "+id+"<br>"+"学生name: "+name;
}

这时候前端就不可以使用name和id作为参数的key值了

如果没有传递s1和s2,前端页面直接报异常!这对用户来讲显然不太友好.如果查看控制台的日志就会发现报出了这样一个警告:

如果使用了@RequestParam注解,这个参数就变成了必传参数

如果不想前端页面崩溃,我们需要手动更改required属性

@RequestMapping("/stu")
public String getStu(@RequestParam(value = "s1",required = false) Integer             
                    id,@RequestParam(value = "s2",required = false) String name){

   return "学生id: "+id+"<br>"+"学生name: "+name;

}

此时即使不传参数,前端也会返回正常的数据.

3.1.4 传递普通对象

刚才我们使用getStu方法接收到一个学生的name和id,如果要求还要接收学生的age,sex等属性,我们还需要一个个地在方法里面添加吗?

聪明的你一定想到了,这时候就需要传递一个对象,当需要传递的参数更改时,只需要修改对象的成员变量即可.

现在我们定义一个Student类,并重写toString方法方便打印该对象.

public class Student {
    private Integer id;
    private String name;
    private Integer age;

    public Integer getId() {
        return id;
    }


    public void setId(Integer id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public Integer getAge() {
        return age;
    }

    public void setAge(Integer age) {
        this.age = age;
    }

    @Override
    public String toString() {
        return "Student{" +
                "id=" + id +
                ", name='" + name + '\'' +
                ", age=" + age +
                '}';
    }
}

来修改一下后端接收的参数

@RequestMapping("/stu")
public String getStu(Student student){//接收类型为Student类
     return student.toString();
}

那么问题来了,该怎么从前端获取到这个对象呢?

答案同样简单,前端只需要传递Student对象的属性值即可.

不论是通过QueryString还是form表单的格式,服务器都可以成功获取到Student对象.

3.1.5 传递JSON对象

实际上,JSON对象在前后端中的传递也很常见,因此后端也需要学会如何接收一个JSON格式的对象.

使用postman传递一个JSON格式的字符串,如果后端仍然按照一个普通对象进行接收,就会出现如下情况

后端没有识别出任何参数! 因此我们需要使用一个注解@RequestBody,表示前端传来的参数是一个JSON对象

@RequestMapping("/stu")
public String getStu(@RequestBody Student student){
    return student.toString();
}

3.1.6 传递数组

前端如果想传递一个数组,只需要多传几组(key,value)键值对,它们的key都相同;后端接收使用数组类型接收这个键值对即可.

 @RequestMapping("/nums")
 public String getNums(Integer[] nums){//接收一个整形数组
    String result="";
    for (Integer num : nums) {
        result+=num+" ";
    }
    return result;
 }

3.1.7 传递集合

实际上,集合也是由相同类型的元素组成的,但是后端接收的时候肯定不能像接收数组那样

接收集合需要用到@RequestParam注解

@RequestMapping("/list")
public String getList(@RequestParam("num") List<Integer> list){//list接收前端传来的num值
    return "size: "+list.size();
}

3.1.8 上传文件

在实际业务中,往往会涉及到上传头像,附件等操作,那么在Spring框架下该如何接收呢?需要用到@RequestPart注解

下面来演示一下该注解的使用

@RequestMapping("/part")
    public String getPart(@RequestPart("file") MultipartFile file) throws IOException {
        //指定e盘下的一个路径
        String path="e:/";
        //因为不同用户会上传不同的文件,不能给它们统一命名,否则会覆盖
        path+= UUID.randomUUID();
        //获取文件名后缀,这样可以存储不同类型的文件
        String suffix=file.getOriginalFilename().substring(file.getOriginalFilename().lastIndexOf("."));
        path+=suffix;
        //将前端上传的文件存到该路径下
        file.transferTo(new File(path));
        //返回该路径名称
        return "已存入"+path;
    }

下面我们用postman来模拟上传一个文件

随机选择一张图片上传

3.1.9 获取URL中的参数

现在点开今日头条,随机选择一篇新闻,我们会发现它的URL是这样的...

黑色箭头指向的那一部分,推测和日期有关,按照我们之前学过的内容,可以把该请求设置成"?datetime=202311"这样的QueryString格式,用于表示客户端请求哪一资源,但是这一功能也可以通过URL的路径设置来实现.

那么服务器如何得知客户端想访问哪一个资源呢?需要使用@PathVariable注解得到URL中的路径变量

下面演示一下~

@RequestMapping("/path/{name}/{age}")//规定客户端的访问路由必须是"/path/用户名/年龄"的格式

    public String getPathV(@PathVariable("name")String name,@PathVariable("age")Integer age){//注解()里的名字需要和路径对应

        return "用户名为>>"+name+";密码为>>"+age;

    }

现在来访问这一路由

需要注意的是,前端访问的路由必须与后端匹配,否则会报404错误

3.1.10 获取请求中的Header

可以使用@RequestHeader获取请求中Header的某一个key对应的value

 @RequestMapping("/header")
    public String getHeader(@RequestHeader("user-agent")String agent){//获取客户端浏览器信息
        return "user agent: "+agent;
    }

3.2 有关Cookie和Session的注解

来简单回顾一下Cookie和Session

HTTP协议本身是"无状态"的,也就是说它没有任何记忆功能,同一个客户端,不论访问几次,每次都会被服务器当成新客户端.但这样做有些弊端--我们不能每次一刷新就得重新登陆一次账号.

Cookie是客户端机制,用于保存服务器传来的数据,当下次访问该服务器时将该数据返回,让服务器知道自己上次访问时的状态.

Session是服务器机制,服务器本地建立的一个Hash表,key为SessionID,value为客户端的各种信息.当客户端拿着SessionID来找服务器时,服务器就可以识别出客户端的身份进行对应的服务.

浅浅举个栗子~

第一次进学校的时候,是不是学校都会发给我们一张校园卡,我们只有这张校园卡才能在校园的各个地方进出,这就是Cookie的实现,将学校的数据保存到我们本人手里.

我们返校的时候,是不是要经过门卫大爷的审问?他会要求检查你的校园卡,如果确认这张校园卡是这个学校的,并且该学生确实存在,就会放你进去.这就是Session的实现,门卫室的电脑存储了你的身份信息,当你拿着SessionID(校园卡上的学号)去找它的时候,就可以检查出你的信息.

注意:Session和Cookie实际上并没有什么联系,在一些场景下,SessionId会通过Cookie机制返回给服务器.但是也可以不使用Cookie(如果你和门卫大爷混的熟了,你的脸就是SessionID,不必刷校园卡进学校了)

3.2.1 Cookie的设置

这一部分和Servlet时代是一样的.我们先创建一个新的Controller类StuCon

@RequestMapping("/stu")
@RestController
public class StuCon {

    @RequestMapping("/set_cookie")
    public String setCookie(String name, String psd, HttpServletResponse response){
        //创建Cookie
        Cookie cookie=new Cookie("name",name);
        Cookie cookie1=new Cookie("age",psd);
        //添加Cookie
        response.addCookie(cookie);
        response.addCookie(cookie1);
        return "set cookie success!";
    }
}

Spring内置了Servlet,因此Servlet的对象HttpServletResponse,HttpServletRequest也是Spring的内置对象,如果某个方法需要使用这些对象,直接在参数列表标明即可.

使用浏览器访问该路由...

这时我们可以看到,客户端本地确实保存了Cookie的信息

3.2.2 Cookie的获取

先来看看传统的获取方式吧.

@RequestMapping("/get_cookie")

    public String getCookie(HttpServletRequest request){
        //从客户端的请求中得到Cookie
        Cookie[] cookies=request.getCookies();
        if(cookies==null) return "没有任何Cookie";
        else{
            //将每个Cookie键值对返回
            String result="";
            for (Cookie cookie : cookies) {
                result+=cookie.getName()+":";
                result+=cookie.getValue()+"<br>";
            }
            return result;
        }
    }

因为Cookie是保存在客户端这边的,我们可以使用浏览器多伪造一些Cookie传给服务器

访问该路由,服务器就会返回以下数据~

重头戏来了,下面来康康Spring可以直接使用@CookieValue注解获取到对应的Cookie值

 @RequestMapping("/get_cookie2")
    public String getCookie(@CookieValue("name")String name){//获取Cookie中key为name的值
        return "name: "+name;
    }

重启服务器,由于Cookie是在客户端保存的,因此客户端访问该服务器时仍然带上了Cookie

3.2.3 Session的存取

先来回顾一下传统的Session存储.

@RequestMapping("/set_session")
    public String setSession(String name,HttpServletRequest request){
        HttpSession session=request.getSession(true);//如果没有为该客户端创建session则创建一个
        session.setAttribute("name",name);
        return "set session success!";
    }

现在用传统的方式来获取一下Session

 @RequestMapping("/get_session")
    public String getSession(HttpServletRequest request){
        HttpSession session=request.getSession(false);//如果没有该客户端的session也不创建
        if(session==null||session.getAttribute("name")==null) return "未set session!";
        else return "name: "+ session.getAttribute("name");
    }

打开服务器

Spring的内置对象还有HttpSession,如果在参数列表中加上该对象时,相当于HttpSession session=request.getSession(true);可以使用该对象存取session

@RequestMapping("/get_session2")

    public String getSession(HttpSession session){
        String name= (String) session.getAttribute("name");
        return "name: "+name;
    }

现在来访问一下这个路由

可以看到,如果session为null,服务器就会抛空指针异常,但事实并非如此.

除了使用内置对象,我们还可以使用@SessionAttribute获取到session的key对应的value值,但要求session必须存在

@RequestMapping("/get_session3")
    public String getSession(@SessionAttribute("name")String name){
        return "name: "+name;
    }

如果我们先访问get_session3路由

因此必须先设置Session然后进行获取

看@SessionAttribute注解,会发现也有required这一属性,可以将它修改为false

@RequestMapping("/get_session3")
public String getSession(@SessionAttribute(value = "name",required = false)String name){
//session中不必非得有key为"name"

        return "name: "+name;
}

这样也就不用先set session再get session了,但是我们的到的value值一定为null

3.3 有关http响应的注解

3.3.1 返回数据

同学们有没有发现,我们之前定义的方法返回的全部是String类型,实际上,这要归功于一个注解@RestController

一起来看看这个注解的源码吧

@Controller是Spring的注解,讲到Spring的原理时我们再详细进行解释,现在要关注的是@ResponseBody

来看一下这个注解的源码

@ResponseBody既是类注解,也是方法注解
如果作用在类上,表示该类的所有方法返回的都是数据;如果作用到方法上,表示该方法返回的是数据
如果不添加该注解,默认返回的是视图

3.3.1.1 返回字符串数据

@Controller
@RequestMapping("/response")
public class ResponseCon {

    @ResponseBody
    @RequestMapping("/get_string")
    public String getString(){
        return "该方法返回字符串!";
    }

}

现在我们来访问这个路由

通过抓包可以看到,返回字符串时的http响应的格式为text/html

3.3.1.2 返回html片段

实际上返回的还是字符串,只不过返回的字符串是按照html的格式进行组织的

  @ResponseBody
    @RequestMapping("/get_html")
    public String getHtml(){
        return "<h2>这是html片段</h2>";//返回的html页面,该页面上的字体为h2标题大小
    }

来访问一下这个路由

3.3.1.3 返回JSON对象

来看一下Servlet时代后端是怎么返回JSON对象的

@ResponseBody
@RequestMapping("/get_json")
public String getJSON(Student student) throws JsonProcessingException {//接收前端传来的Student对象
        ObjectMapper mapper=new ObjectMapper();
        String result=mapper.writeValueAsString(student);//借助ObjectMapper对象将java对象转变为JSON字符串
        return result;
}

当我们访问这个路由时,就会得到一个JSON格式的字符串

实际上,在SpringMVC项目中,返回一个JSON对象很简单,直接返回即可

@ResponseBody
@RequestMapping("/get_json2")
public Student getStu(Student student){

     return student;

}

访问该路由并抓包

可以看到,响应中返回body的格式被设置成了application/json

除了返回对象,当我们返回的是Map对象时,也会被设置成json格式的字符串

@RequestMapping("/get_map")
@ResponseBody
public Map getMap(){
   Map<Integer,String> map=new HashMap<>();
   map.put(1,"cat");
   map.put(2,"dog");
   map.put(3,"pig");
   return map;
}

3.3.2 返回视图

来猜一下,返回视图的话需要什么注解?

答案是不需要任何注解!默认返回的就是视图

刚才提到过,html等静态页面放置在static目录下,现在我们在该目录下创建一个简单的index.html页面

<!doctype html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport"
          content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
    <meta http-equiv="X-UA-Compatible" content="ie=edge">
    <title>index</title>
</head>
<body>
    <h1>这是index页面</h1>
</body>
</html>

现在我们访问ResponseCon的getIndex方法,让该方法返回这个index页面

@RequestMapping("/get_view")
public String getIndex(){
        return "/index.html";//'/'必须加,表示根目录是static目录
 }

现在来抓一下包

3.3.2.1 重定向 VS 请求转发

请求转发是服务器帮助客户端获取到URL指定的资源

重定向是服务器将新的URL返回给客户端,然后客户端去访问这个URL

举个栗子~最近天气转凉,你叫上老妈帮忙找冬衣,如果妈妈采用的是重定向的方式,就会告诉你衣服在哪里,让你自己去找;如果妈妈采用的是请求转发的方式,就会把衣服找好交给你

实际上,SPring可以根据forward(请求转发)和redirect(重定向)来设置

@RequestMapping("/get_view")
    public String getIndex(){
        return "forward:/index.html";//请求转发
    }

@RequestMapping("/get_view2")
    public String getIndex2(){
        return "redirect:/index.html";//重定向
    }

3.3.3 设置Contet-Type

响应的返回类型可以通过@RequestMapping设置

现在指定响应类型为application/json

@ResponseBody
@RequestMapping(value = "/get_json",produces = "application/json")//原本返回类型应该是text/html
    public String getJSON(Student student) throws JsonProcessingException {
        ObjectMapper mapper=new ObjectMapper();
        String result=mapper.writeValueAsString(student);
        return result;
    }