【SpringMVC】SpringMvc基础-常用注解、对象和json或xml之间的转换

简介: 【SpringMVC】SpringMvc基础-常用注解、对象和json或xml之间的转换

Spring MVC常用注解


@Controller


@Controller注解在类上,表明这个类是Spring MVC里的Controller,将其声明为Spring的一个Bean,Dispatcher Servlet会自动扫描注解了此注解的类,并将Web请求映射到注解了@RequestMapping的方法上。


在声明普通Bean的时候,使用@Component、@Service、@Repository和@Controller是等同的,因为@Service、@Repository、@Controller都组合了@Component注解。

但在Spring MVC声明控制器Bean的时候,只能使用@Controller。


@RequestMapping


@RequestMapping注解是用来映射Web请求(访问路径和参数)、处类和方法的。

@RequestMapping可注解在类或者方法上。注解在方法上的@RequestMapping路径会继承注解在类上的路径,@RequestMapping支持Servlet的request和response作为参数,也支持对request和response的媒体类型进行配置。


@ResponseBody


@ResponseBody支持将返回值放在response体内,而不是返回一个页面。

我们在很多基于Ajax的程序的时候,可以以此注解返回数据而不是页面,此注解可以放置在返回值前或者方法上。


@RequestBody


@RequestBody允许request的参数在request体中,而不是在直接链接的地址后面。此注解放置在参数前。


@requestBody可以将请求体中的JSON字符串绑定到相应的bean上,当然,也可以将其分别绑定到对应的字符串上


例如说以下情况:


 

$.ajax({
        url:"/login",
        type:"POST",
        data:'{"userName":"admin","pwd","admin123"}',
        content-type:"application/json charset=utf-8",
        success:function(data){
          alert("request success ! ");
        }
    });
    @requestMapping("/login")
    public void login(@requestBody String userName,@requestBody String pwd){
      System.out.println(userName+" :"+pwd);
    }

这种情况是将JSON字符串中的两个变量的值分别赋予了两个字符串,但是呢假如我有一个User类,拥有如下字段:

     String userName;

     String pwd;

那么上述参数可以改为以下形式:@requestBody User user 这种形式会将JSON字符串中的值赋予user中对应的属性上

需要注意的是,JSON字符串中的key必须对应user中的属性名,否则是请求不过去的。


@PathVariable


@PathVariable用来接收路径参数,如/new/001,可接收001作为参数,此注解放置在参数前。


例如:


@RequestMapping(value = "/new/{str}",produces = "text/plain;charset=UTF-8")
//@ResponseBody 放方法上也可以的
public @ResponseBody String demoPathVar(@PathVariable String str){
    return str;
}


@RestController


@RestController是一个组合注解,组合了@Controller和@ResponseBody,这就意味着当你只开发一个和页面交互数据的控制的时候,需要使用此注解。

若没有此注解诶,要想实现上述功能,则需要自己在代码中加上@Controller和@ResponseBody两个注解。


示例


下面这个示例将演示这几个注解的使用。

以及利用jackson,获得对象和json或xml之间的转换!


 

<dependency>
            <groupId>com.fasterxml.jackson.dataformat</groupId>
            <artifactId>jackson-dataformat-xml</artifactId>
            <version>2.8.5</version>
        </dependency>


在实际项目中,我们其实主要是支持json数据,没必要同时支持json和xml,因为json比xml更加简洁。

由于JavaScript的广泛使用,json成为最推荐的格式,在这种情况下,我们的依赖包如下(上面的依赖包包含下面的依赖包):


   

<dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-databind</artifactId>
            <version>2.8.5</version>
        </dependency>


package cn.hncu.model;
/**
 * Created with IntelliJ IDEA.
 * User: 陈浩翔.
 * Date: 2017/2/20.
 * Time: 下午 8:59.
 * Explain:此类用于演示获取request对象参数和返回此对象到response
 */
public class DemoObj {
    private Long id;
    private String name;
    public DemoObj() {
    }
    public Long getId() {
        return id;
    }
    public void setId(Long id) {
        this.id = id;
    }
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
}

注意:jackson对对象和json做转换时一定需要空构造!!!

注解演示控制器

演示代码

package cn.hncu;
import cn.hncu.model.DemoObj;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import javax.servlet.http.HttpServletRequest;
/**
 * Created with IntelliJ IDEA.
 * User: 陈浩翔.
 * Date: 2017/2/20.
 * Time: 下午 9:02.
 * Explain:控制器
 */
@Controller //声明此类是一个控制器
@RequestMapping("/chx") //映射此类的访问路径是/chx
public class DemoAnnoController {
    private static Logger logger = LoggerFactory.getLogger(DemoAnnoController.class);
    @RequestMapping(produces = "text/plain;charset=UTF-8")
    //此方法未标注路径,因此使用类级别的路径/chx;
    // produces可定制返回的response的媒体类型和字符集,或需返回值是json对象,则设置produces = "text/plain;charset=UTF-8"
    public @ResponseBody String index(HttpServletRequest request){
        //演示可接受HttpServletRequest作为参数,当然也可以接受HttpServletResponse作为参数,此处的@ResponseBody用在返回值前面
        logger.info("进入index方法!访问路径是:"+request.getRequestURI());
        return "url:"+request.getRequestURI()+" can access";
    }
    //演示接受路径参数,并在方法参数前结合@PathVariable使用!
    @RequestMapping(value = "/pathvar/{str}",produces = "text/plain;charset=UTF-8")
    public @ResponseBody String demoPathVar(@PathVariable String str,HttpServletRequest request){
        logger.info("进入demoPathVar方法!访问路径是:"+request.getRequestURI());
        return "url:"+request.getRequestURI()+" can access";
    }
    //演示常规的request参数获取,访问路径为/chx/requestParam?id=001
    @RequestMapping(value = "/requestParam",produces = "text/plain;charset=UTF-8")
    public @ResponseBody String passRequestParam(Long id,HttpServletRequest request){
        logger.info("进入passRequestParam方法!访问路径是:"+request.getRequestURI());
        return "url:"+request.getRequestURI()+" can access,id:"+id;
    }
    //演示解释参数到对象,访问路径为/chx/obj/?id=001&name=chx
    @RequestMapping(value = "obj",produces = "application/json;charset=UTF-8")
    @ResponseBody //也可以放在方法上
    public String passObj(DemoObj obj,HttpServletRequest request){
        logger.info("进入passObj方法!访问路径是:"+request.getRequestURI());
        return "url:"+request.getRequestURI()+" can access,obj id:"+obj.getId()+" obj name:"+obj.getName();
    }
    //演示映射不同的路径到相同的方法上。
    //访问路径为/chx/name1 或/cha/name2
    @RequestMapping(value = {"/name1","name2"},produces = "text/plain;charset=UTF-8")
    public @ResponseBody String remove(HttpServletRequest request){
        logger.info("进入remove方法!访问路径是:"+request.getRequestURI());
        return "url:"+request.getRequestURI()+" can access";
    }
}

演示结果

image.png

image.png

image.png

image.png

@RestController演示

代码

package cn.hncu;
import cn.hncu.model.DemoObj;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
/**
 * Created with IntelliJ IDEA.
 * User: 陈浩翔.
 * Date: 2017/2/20.
 * Time: 下午 10:10.
 * Explain: @RestController演示
 */
@RestController //声明是控制器,并且返回数据时不需要@ResponseBody
@RequestMapping("rest")
public class DemoRestController {
    private static Logger logger = LoggerFactory.getLogger(DemoAnnoController.class);
    @RequestMapping(value = "getjson",produces = "application/json;charset=UTF-8")//返回数据的媒体类型为json
    public DemoObj getjson(DemoObj obj){
        logger.info("进入getjson方法.");
        return new DemoObj(obj.getId()+1,obj.getName()+" json");//直接返回对象,对象会自动转换成json
    }
    @RequestMapping(value = "getxml",produces = "application/xml;charset=UTF-8")//返回数据的媒体类型是xml
    public DemoObj getxml(DemoObj obj){
        logger.info("进入getxml方法.");
        return new DemoObj(obj.getId()+1,obj.getName()+" xml");//直接返回对象,对象会自动转换为xml
    }
}

演示结果

转换成json的结果:

image.png

转换成xml的结果:

image.png

本篇博客涉及到的源码链接:

 ->点击访问源码-©CHX

目录
相关文章
|
19天前
|
SQL Java 数据库连接
对Spring、SpringMVC、MyBatis框架的介绍与解释
Spring 框架提供了全面的基础设施支持,Spring MVC 专注于 Web 层的开发,而 MyBatis 则是一个高效的持久层框架。这三个框架结合使用,可以显著提升 Java 企业级应用的开发效率和质量。通过理解它们的核心特性和使用方法,开发者可以更好地构建和维护复杂的应用程序。
110 29
|
2月前
|
设计模式 前端开发 Java
步步深入SpringMvc DispatcherServlet源码掌握springmvc全流程原理
通过对 `DispatcherServlet`源码的深入剖析,我们了解了SpringMVC请求处理的全流程。`DispatcherServlet`作为前端控制器,负责请求的接收和分发,处理器映射和适配负责将请求分派到具体的处理器方法,视图解析器负责生成和渲染视图。理解这些核心组件及其交互原理,有助于开发者更好地使用和扩展SpringMVC框架。
69 4
|
3月前
|
前端开发 Java Spring
Spring MVC核心:深入理解@RequestMapping注解
在Spring MVC框架中,`@RequestMapping`注解是实现请求映射的核心,它将HTTP请求映射到控制器的处理方法上。本文将深入探讨`@RequestMapping`注解的各个方面,包括其注解的使用方法、如何与Spring MVC的其他组件协同工作,以及在实际开发中的应用案例。
67 4
|
3月前
|
前端开发 Java 开发者
Spring MVC中的请求映射:@RequestMapping注解深度解析
在Spring MVC框架中,`@RequestMapping`注解是实现请求映射的关键,它将HTTP请求映射到相应的处理器方法上。本文将深入探讨`@RequestMapping`注解的工作原理、使用方法以及最佳实践,为开发者提供一份详尽的技术干货。
234 2
|
3月前
|
前端开发 Java Spring
探索Spring MVC:@Controller注解的全面解析
在Spring MVC框架中,`@Controller`注解是构建Web应用程序的基石之一。它不仅简化了控制器的定义,还提供了一种优雅的方式来处理HTTP请求。本文将全面解析`@Controller`注解,包括其定义、用法、以及在Spring MVC中的作用。
84 2
|
3月前
|
前端开发 Java 开发者
Spring MVC中的控制器:@Controller注解全解析
在Spring MVC框架中,`@Controller`注解是构建Web应用程序控制层的核心。它不仅简化了控制器的定义,还提供了灵活的请求映射和处理机制。本文将深入探讨`@Controller`注解的用法、特点以及在实际开发中的应用。
169 0
|
5月前
|
XML Java 应用服务中间件
springMVC01,springMVC的执行流程【第一个springMVC例子(XML配置版本):HelloWorld】
通过一个HelloWorld实例,介绍了SpringMVC的基本概念、执行流程,并详细讲解了如何创建和配置第一个SpringMVC项目(基于XML)。
springMVC01,springMVC的执行流程【第一个springMVC例子(XML配置版本):HelloWorld】
|
4月前
|
JSON 前端开发 Java
SSM:SpringMVC
本文介绍了SpringMVC的依赖配置、请求参数处理、注解开发、JSON处理、拦截器、文件上传下载以及相关注意事项。首先,需要在`pom.xml`中添加必要的依赖,包括Servlet、JSTL、Spring Web MVC等。接着,在`web.xml`中配置DispatcherServlet,并设置Spring MVC的相关配置,如组件扫描、默认Servlet处理器等。然后,通过`@RequestMapping`等注解处理请求参数,使用`@ResponseBody`返回JSON数据。此外,还介绍了如何创建和配置拦截器、文件上传下载的功能,并强调了JSP文件的放置位置,避免404错误。
|
5月前
|
缓存 前端开发 Java
【Java面试题汇总】Spring,SpringBoot,SpringMVC,Mybatis,JavaWeb篇(2023版)
Soring Boot的起步依赖、启动流程、自动装配、常用的注解、Spring MVC的执行流程、对MVC的理解、RestFull风格、为什么service层要写接口、MyBatis的缓存机制、$和#有什么区别、resultType和resultMap区别、cookie和session的区别是什么?session的工作原理
|
4月前
|
前端开发 Java 应用服务中间件
【Spring】Spring MVC的项目准备和连接建立
【Spring】Spring MVC的项目准备和连接建立
79 2