SpringMvc4.x-2(常用注解)

爱被打了一巴掌 2022-05-16 06:44 187阅读 0赞

## 1. @Controller ##

`@Controller`注解在类上，表明这个类是`Spring ``MVC`里面的`Controller`，将其声明为`Spring`的一个`Bean`，`DispatcherServlet`会自动扫描注解了此注解的类，并将请求映射到注解了`@RequestMapping`的方法上，这里特别指出，在声明普通`Bean`的时候，使用`@Component`，`@Service`，`@Repository`和`@Controller`是等同的，因为`@Controller`，`@Service`，`@Repository`都组合了`@Component`元注解，但在`Spring ``MVC`声明控制器`Bean`的时候，只能使用`@Controller`。

## 2. @RequestMapping ##

`@RequestMapping`注解是用来映射`Web`请求(访问路径和参数)，处理类和方法的。`@RequestMapping`可注解在类或者方法上。注解在方法上的`@RequestMapping`路径会继承注解在类上的路径，`@RequestMapping`支持`Servlet`的`request`和`response`作为参数，也支持对`request`和`response`的媒体类型进行配置。

## 3.@ResponseBody ##

`@ResponseBody`支持将返回值放在`response`体内，而不是返回一个页面。我们在很多基于`Ajax`程序的时候，可以以此注解返回数据而不是页面；此注解可放置在返回值前或者方法上。

## 4. @RequestBody ##

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

## 5. @PathVariable ##

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

## 6.@RestController ##

`@RestController`是一个组合注解，组合了`@Controller`和`@ResponseBody`，这就意味着当你只开发一个和页面交互数据的控制的时候，需要使用此注解。若没有此注解，要想实现上述功能，则需要自己在代码中加`@Controller`和`@ResponseBody`两个注解。

## 二. 示例 ##

## 1. 传值类 ##

添加`jackson`以及相关依赖，获得对象和`json`和`xml`之间的转换

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

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

import javax.servlet.http.HttpServletRequest;
    
    import org.light4j.springMvc4.domain.DemoObj;
    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;
    
    /**
     * ①@Controller注解声明此类是一个控制器 ② @RequestMapping("/anno")映射此类的访问路径是/anno。
     * ③此方法未标注路径，因此使用类级别的路径/anno;produces可定制返回的response的媒体类型和字符集，或返回值是json对象，则设置porduces="application/json;charset=UTF-8"，在后面会演示此项特性。
     * ④演示可接受HttpServletRequest作为参数，当然也可以接受HttpServletResponse作为参数。此处的@ResponseBody用在返回值前。
     * ⑤演示接受路径参数，并在方法参数前结合@PathVariable使用，访问路径为/anno/pathvar/xxx。 
     * ⑥演示常规的request参数获取，访问路径为/anno/requestParam?id=1。 
     * ⑦演示解释参数到对象，访问路径为/anno/obj?id=1&name=xx。
     * ⑧ @ResponseBody也可以用在方法上。 
     * ⑨演示映射不同的路径到相同的方法，访问路径为/anno/name1或/anno/name2。
     * 
     * @author Administrator
     *
     */
    @Controller // ①
    @RequestMapping("/anno") // ②
    public class DemoAnnoController {
    
    	@RequestMapping(produces = "text/plain;charset=UTF-8") // ③
    	public @ResponseBody String index(HttpServletRequest request) { // ④
    		return "url:" + request.getRequestURL() + " can access";
    	}
    
    	@RequestMapping(value = "/pathvar/{str}", produces = "text/plain;charset=UTF-8") // ⑤
    	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") // ⑥
    	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") // ⑦
    	@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") // ⑨
    	public @ResponseBody String remove(HttpServletRequest request) {
    
    		return "url:" + request.getRequestURL() + " can access";
    	}
    }

## 3. @RestController演示 ##

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