springmvc常用注解标签详解

男娘i 2024-04-17 05:30 17阅读 0赞

### 注解标签： ###

*  一、组件型注解：
 *   *  1.1 @Controller
     *  1.2 @RequestMapping：
     *  1.3 @RequestParam：
     *  1.4 @PathViriable：
     *  1.5 @ResponseBody：
     *  1.6 @ModelAttribute
     *  1.7 @SessionAttributes
     *  1.8 @Resource和@Autowired

# 一、组件型注解： #

1.@Component 在类定义之前添加@Component注解，他会被spring容器识别，并转为bean。2.@Repository 对Dao实现类进行注解 (特殊的@Component)  
3.@Service 用于对业务逻辑层进行注解， (特殊的@Component)  
4.@Controller 用于控制层注解 ， (特殊的@Component)  
　以上四种注解都是注解在类上的，被注解的类将被spring初始话为一个bean，然后统一管理。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xhbjM2Mjk3OTY_size_16_color_FFFFFF_t_70]

## 1.1 @Controller ##

在SpringMVC 中，控制器Controller 负责处理由DispatcherServlet 分发的请求，它把用户请求的数据经过业务处理层处理之后封装成一个Model ，然后再把该Model 返回给对应的View 进行展示。在SpringMVC 中提供了一个非常简便的定义Controller 的方法，你无需继承特定的类或实现特定的接口，只需使用@Controller 标记一个类是Controller ，然后使用@RequestMapping 和@RequestParam 等一些注解用以定义URL 请求和Controller 方法之间的映射，这样的Controller 就能被外界访问到。此外Controller 不会直接依赖于HttpServletRequest 和HttpServletResponse 等HttpServlet 对象，它们可以通过Controller 的方法参数灵活的获取到。  
（2）在SpringMVC 的配置文件中告诉Spring 该到哪里去找标记为@Controller 的Controller 控制器。

<–方式一–>

<–方式二–>

< context:component-scan base-package = "com.host.app.web" />

//路径写到controller的上一层(扫描包详解见下面浅析)

## 1.2 @RequestMapping： ##

@RequestMapping：用于处理请求地址映射，可以作用于类和方法上。  
**value**：定义request请求的映射地址  
**method**：定义地request址请求的方式，包括【GET, POST, HEAD, OPTIONS, PUT, PATCH, DELETE, TRACE.】默认接受get请求，如果请求方式和定义的方式不一样则请求无法成功。  
**params**：定义request请求中必须包含的参数值。  
**headers**：定义request请求中必须包含某些指定的请求头，如：RequestMapping(value = “/something”, headers = “content-type=text/\*”)说明请求中必须要包含"text/html", "text/plain"这中类型的Content-type头，才是一个匹配的请求。  
**consumes**：定义请求提交内容的类型。  
**produces**：指定返回的内容类型，仅当request请求头中的(Accept)类型中包含该指定类型才返回

## 1.3 @RequestParam： ##

@RequestParam：用于获取传入参数的值  
value：参数的名称  
required：定义该传入参数是否必须，默认为true，（和@RequestMapping的params属性有点类似）

@RequestMapping("/requestParams2.do")
        public String requestParams2(@RequestParam(value = "name",required = false) String names){
            System.out.println("name = "+names);
            return "index";
        }

## 1.4 @PathViriable： ##

@PathViriable：用于定义路径参数值  
value：参数的名称  
required：定义传入参数是否为必须值

@RequestMapping("/{myname}/pathVariable2.do")
        public String pathVariable2(@PathVariable(value = "myname") String name){
            System.out.println("myname = "+name);
            return "index";
        }

## 1.5 @ResponseBody： ##

@ResponseBody：作用于方法上，可以将整个返回结果以某种格式返回，如json或xml格式

@RequestMapping("/{myname}/pathVariable2.do")
    2     @ResponseBody
    3     public String pathVariable2(@PathVariable(value = "myname") String name){
    4         System.out.println("myname = "+name);
    5         return "index";
    6     }

和上一段例子一样，只是添加了@ResponseBody标签，然后返回结果为：  
![在这里插入图片描述][20190828100133143.png]  
它返回的不是一个页面，而是把字符串“index”直接在页面打印出来了，这其实和如下代码时类似的。

1 PrintWriter out = resp.getWriter();
    2 out.print("index");
    3 out.flush();

@CookieValue：用于获取请求的Cookie值

@RequestMapping("/requestParams.do")
    2     public String requestParams(@CookieValue("JSESSIONID") String cookie){
    3         return "index";
    4     }

## 1.6 @ModelAttribute ##

@ModelAttribute：用于把参数保存到model中，可以注解方法或参数，注解在方法上的时候，该方法将在处理器方法执行之前执行，然后把返回的对象存放在 session（前提时要有@SessionAttributes注解） 或模型属性中，@ModelAttribute(“attributeName”) 在标记方法的时候指定，若未指定，则使用返回类型的类名称（首字母小写）作为属性名称。　\`

@ModelAttribute("user")
        public UserEntity getUser(){
            UserEntity userEntityr = new UserEntity();
            userEntityr.setUsername("asdf");
            return userEntityr;
        }
    
        @RequestMapping("/modelTest.do")
        public String getUsers(@ModelAttribute("user") UserEntity user){
            System.out.println(user.getUsername());
            return "/index";
        }

## 1.7 @SessionAttributes ##

默认情况下Spring MVC将模型中的数据存储到request域中。当一个请求结束后，数据就失效了。如果要跨页面使用。那么需要使用到session。而@SessionAttributes注解就可以使得模型中的数据存储一份到session域中。配合@ModelAttribute(“user”)使用的时候,会将对应的名称的model值存到session中

@Controller
    @RequestMapping("/test")
    @SessionAttributes(value = {"user","test1"})
    public class LoginController{
        @ModelAttribute("user")
        public UserEntity getUser(){
            UserEntity userEntityr = new UserEntity();
            userEntityr.setUsername("asdf");
            return userEntityr;
        }
    
        @RequestMapping("/modelTest.do")
        public String getUsers(@ModelAttribute("user") UserEntity user ,HttpSession session){
            System.out.println(user.getUsername());
            System.out.println(session.getAttribute("user"));
            return "/index";
        }
    }

@Repository  
用于注解dao层，在daoImpl类上面注解。

## 1.8 @Resource和@Autowired ##

@Resource和@Autowired都是做bean的注入时使用，其实@Resource并不是Spring的注解，它的包是javax.annotation.Resource，需要导入，但是Spring支持该注解的注入。

1、共同点

两者都可以写在字段和setter方法上。两者如果都写在字段上，那么就不需要再写setter方法。

2、不同点

（1）@Autowired

@Autowired为Spring提供的注解，需要导入包org.springframework.beans.factory.annotation.Autowired;只按照byType注入。

public class TestServiceImpl {
        // 下面两种@Autowired只要使用一种即可
        @Autowired
         @Qualifier("userDao")
        private UserDao userDao; // 用于字段上
        
        @Autowired
        public void setUserDao(UserDao userDao) { // 用于属性的方法上
            this.userDao = userDao;
        }
    }
    public class TestServiceImpl {
        // 下面两种@Resource只要使用一种即可
        @Resource(name="userDao")
        private UserDao userDao; // 用于字段上
        
        @Resource(name="userDao")
        public void setUserDao(UserDao userDao) { // 用于属性的setter方法上
            this.userDao = userDao;
        }
    }

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xhbjM2Mjk3OTY_size_16_color_FFFFFF_t_70]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/11/4588fed1fd3d4fc0aae0610e7dffedcd.png
[20190828100133143.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/11/f54d1291da474006b5408e9b35cc2687.png