Spring Boot实战（四）Spring MVC基础 4.3 Spring MVC的常用注解

Spring MVC常用以下几个注解。
（1）@Controller注解在类上，表明这个类是SpringMVC里的Controller，将其声明为Spring的一个Bean，Dispatcher Servlet会自动扫描注解了此注解的类（这里和我们在1.3.3节演示用注解作为拦截方式的例子原理类似），并将Web请求映射到注解了@RequestMapping的方法上。这里特别指出，在声明普通Bean的时候，使用@Component、@Service、@Repository和@Controller是等同的，因为@Service、@Repository、@Controller都组合了@Compoment元注解；但在SpringMVC声明控制器Bean的时候，只能使用@Controller。
（2）@RequestMapping注解是用来映射Web请求（访问路径和参数）、处理类和方法的。@RequestMapping可注解在类或方法上。注解在方法上的@RequestMapping路径会继承注解在类上的路径，@RequestMapping支持Servlet的request和response作为参数，也支持对request和response的媒体类型进行配置。
（3）@RequestBody
@RequestBody允许request的参数在request体中，而不是在直接链接在地址后面。此注解放置在参数前。
（4）@ResponseBody
@ResponseBody支持将返回值放在response体内，而不是返回一个页面。我们在很多基于Ajax的程序的时候，可以以此注解返回数据而不是页面；此注解可以放置在返回值前或者方法上。
（5）@PathVariable
@PathVariable是用来接收路径参数，如/news/001，可接收001作为参数，此注解放置在参数前，
（6）@RestController
@RestController是一个组合注解，组合了@Controller和@ResponseBody，这就意味着当你只开发一个和页面交互数据的控制的时候，需要使用此注解。若没有此注解，要想实现上述功能，则需自己在代码中加@Controller和@ResponseBody两个注解。
下面的示例将演示这几个注解的使用。
4.3.2 示例
1.传值类
添加jackson及相关依赖，获得对象和json或xml之间的转换：

	<!-- 对json 和 xml 格式的支持 -->
	<dependency>
		<groupId>com.fasterxml.jackson.dataformat</groupId>
		<artifactId>jackson-dataformat-xml</artifactId>
		<version>2.5.3</version>
	</dependency>

这里特别指出，在实际项目中，我们其实主要支持json数据，没必要同时支持json和xml,因为json比xml更简洁。由于JavaScript的广泛使用，json成为最推荐的格式，在这种情况下，我们的依赖包如下（上面的依赖包含下面的依赖）：

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

此类用来演示获取request对象参数和返回此对象到response；

package com.wisely.highlight_springmvc4.domain;

public class DemoObj {
	private Long id;
	private String name;
	
	public DemoObj(){  //jackson对对象和json做转换时一定需要此空构造。
		super();
	}
	
	public DemoObj(Long id,String name){
		super();
		this.id=id;
		this.name=name;
	}

	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;
	}
	
	
}

2.注解演示控制器

package com.wisely.highlight_springmvc4.web.ch4_3;

import javax.servlet.http.HttpServletRequest;

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 com.wisely.highlight_springmvc4.domain.DemoObj;

@Controller  //声明此类是一个控制器
@RequestMapping("/anno")  // 映射此类的访问路径是  /anno
public class DemoAnnoController {
	
	@RequestMapping(produces = "text/plain;charset=UTF-8") //此方法未标注路径，因此使用类级别的路径/anno;produces可定制返回的response的媒体类型和字符集，或需返回值是json对象，则设置produces="application/json;charset=UTF-8",在后面的章节我们会演示此项特性。
	public @ResponseBody String index(HttpServletRequest request){  //演示可接受HttpServletRequest作为参数，当然也可以接受HttpServletResponse作为参数。此处的@ResponseBody用在返回值前面。
		return "url:"+request.getRequestURL() + " can access";
	}
	@RequestMapping(value = "/pathvar/{str}",produces = "text/plain;charset=UTF-8") //演示接受路径参数，并在方法参数前结合@PathVariable使用，访问路径为 /anno/pathvar/xx。
	public @ResponseBody String demoPathVar(@PathVariable String str,HttpServletRequest request){
		return "url:"+request.getRequestURL()+" can access,str: "+ str;
	}
	@RequestMapping(value = "/requestParam" , produces = "text/plain;charset=UTF-8") // 演示常规的request参数获取，访问路径为/anno/requestParam?id=1
	public @ResponseBody String passRequestParam(Long id,HttpServletRequest request){
		return "url:" + request.getRequestURL() + " can access,id: "+ id;
	}
	@RequestMapping(value="/obj",produces="application/json;charset=UTF-8")//演示解释参数到对象，访问路径为/anno/obj?id=1&name=xx
	@ResponseBody  //@ResponseBody也可以用在方法上。
	public String passObj(DemoObj obj,HttpServletRequest request){
		return "url:" + request.getRequestURL() + " can access, obj id: " + obj.getId() + "obj name:" + obj.getName();
	}
	@RequestMapping(value={ "/name1","/name2" },produces="text/plain;charset=UTF-8") //演示映射不同的路径到相同的方法，访问路径为/anno/name1或/anno/name2。
	public @ResponseBody String remove(HttpServletRequest request){
		return "url:"+request.getRequestURL()+"can access";
	}
}

3.@RestController演示

package com.wisely.highlight_springmvc4.web.ch4_3;



import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import com.wisely.highlight_springmvc4.domain.DemoObj;

@RestController //使用@RestController，声明是控制器，并且返回数据时不需要@ResponseBody。
@RequestMapping(value="/rest")
public class DemoRestController {
	@RequestMapping(value="/getjson",produces={"application/json;charset=UTF-8"}) //返回数据的媒体类型为json。
	public DemoObj getjson (DemoObj obj){
		return new DemoObj(obj.getId()+1,obj.getName()+"yy"); //直接返回对象，对象会自动转投成json。
	}
	@RequestMapping(value="/getxml",produces={"application/xml;charset=UTF-8"}) //返回数据类型的媒体类型为xml
	public DemoObj getxml(DemoObj obj){ 
		return new DemoObj(obj.getId()+1,obj.getName()+"yy"); //直接返回对象，对象会自动转换为xml
	}
}

结果如图