Spring mvc implements Restful returned json format data instance details, restfuljson

Spring mvc implements Restful returned json format data instance details, restfuljson

In this example, we will show you how to convert an object to json format and return it to the user through the spring mvc framework.

Technology and Environment:

• Spring 3.2.2.RELEASE
  
• Jackson 1.9.10
  
• JDK 1.6
  
• Eclipse 3.6
  
• Maven 3
  

PS: In spring 3, to output json data, you only need to add the Jackson library to your classpath.

1. Project dependency

Dependencies between spring and jackson:

<project xmlns="http://maven.apache.org/POM/4.0.0"     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0     http://maven.apache.org/maven-v4_0_0.xsd"> <modelVersion>4.0.0</modelVersion> <groupId>com.mkyong.common</groupId> <artifactId>SpringMVC</artifactId> <packaging>war</packaging> <version>1.0-SNAPSHOT</version> <name>SpringMVC Json Webapp</name> <url>http://maven.apache.org</url> <properties> <spring.version>3.2.2.RELEASE</spring.version> <jackson.version>1.9.10</jackson.version> <jdk.version>1.6</jdk.version> </properties> <dependencies> <!-- Spring 3 dependencies --> <dependency>  <groupId>org.springframework</groupId>  <artifactId>spring-core</artifactId>  <version>${spring.version}</version> </dependency> <dependency>  <groupId>org.springframework</groupId>  <artifactId>spring-web</artifactId>  <version>${spring.version}</version> </dependency> <dependency>  <groupId>org.springframework</groupId>  <artifactId>spring-webmvc</artifactId>  <version>${spring.version}</version> </dependency> <!-- Jackson JSON Mapper --> <dependency>  <groupId>org.codehaus.jackson</groupId>  <artifactId>jackson-mapper-asl</artifactId>  <version>${jackson.version}</version> </dependency> </dependencies> <build> <finalName>SpringMVC</finalName> <plugins>  <plugin>  <groupId>org.apache.maven.plugins</groupId>  <artifactId>maven-eclipse-plugin</artifactId>  <version>2.9</version>  <configuration>  <downloadSources>true</downloadSources>  <downloadJavadocs>false</downloadJavadocs>  <wtpversion>2.0</wtpversion>  </configuration>  </plugin>  <plugin>  <groupId>org.apache.maven.plugins</groupId>  <artifactId>maven-compiler-plugin</artifactId>  <version>2.3.2</version>  <configuration>  <source>${jdk.version}</source>  <target>${jdk.version}</target>  </configuration>  </plugin> </plugins> </build></project>

2. Model

A simple JavaBean will be converted to json output later.

public class Shop { String name; String staffName[]; //getter and setter methods}

3. Controller

Add @ ResponseBody to the returned value. We can see that:

The Jackson package is already in the classpath of the project.

Mvc: annotation-driven annotation Enabled

@ ResponseBody has been added to the Return method.

Spring will automatically process json conversion.

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.RequestMethod;import org.springframework.web.bind.annotation.ResponseBody;import com.mkyong.common.model.Shop;[@Controller](https://my.oschina.net/u/1774615)@RequestMapping("/kfc/brands")public class JSONController { @RequestMapping(value="{name}", method = RequestMethod.GET) public @ResponseBody Shop getShopInJSON(@PathVariable String name) { Shop shop = new Shop(); shop.setName(name); shop.setStaffName(new String[]{"mkyong1", "mkyong2"}); return shop; }}

4. mvc: annotation-driven

Enable the mvc: annotation-driven annotation in your spring configuration file.

<beans xmlns="http://www.springframework.org/schema/beans" xmlns:context="http://www.springframework.org/schema/context" xmlns:mvc="http://www.springframework.org/schema/mvc"  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="    http://www.springframework.org/schema/beans       http://www.springframework.org/schema/beans/spring-beans-3.0.xsd    http://www.springframework.org/schema/context     http://www.springframework.org/schema/context/spring-context-3.0.xsd    http://www.springframework.org/schema/mvc    http://www.springframework.org/schema/mvc/spring-mvc-3.0.xsd"> <context:component-scan base-package="com.mkyong.common.controller" /> <mvc:annotation-driven /></beans>

5. Sample Results

Access URL: http: // localhost: 8080/SpringMVC/rest/kfc/brands/kfc-kampar

Spring-mvc-json-demo

Thank you for reading this article. I hope it will help you. Thank you for your support for this site!