Spring MVC常用注解

最新推荐文章于 2023-08-27 08:24:46 发布

呼卓宇

最新推荐文章于 2023-08-27 08:24:46 发布

阅读量416

点赞数 5

分类专栏： Spring MVC 文章标签： Spring MVC常用注解

本文链接：https://blog.csdn.net/qq_38129062/article/details/88823635

版权

Spring MVC 专栏收录该内容

4 篇文章 0 订阅

订阅专栏

Spring MVC常用注解

1. `@Controller`

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

@Controller 用于标记在一个类上，使用它标记的类就是一个SpringMVC Controller 对象。分发处理器将会扫描使用了该注解的类的方法，并检测该方法是否使用了@RequestMapping 注解。

@Controller 只是定义了一个控制器类，而使用@RequestMapping 注解的方法才是真正处理请求的处理器。(单单使用@Controller 标记在一个类上还不能真正意义上的说它就是SpringMVC 的一个控制器类，因为这个时候Spring 还不认识它。)

那么要如何做Spring 才能认识它呢？这个时候就需要我们把这个控制器类交给Spring来管理。有两种方式：

在SpringMVC 的配置文件中定义MyController 的bean 对象。
在SpringMVC 的配置文件中告诉Spring 该到哪里去找标记为@Controller 的Controller 控制器。

//方式一
<bean class="com.host.app.web.controller.MyController"/>

//方式二
< context:component-scan base-package = "com.host.app.web" />
//路径写到controller的上一层

2. `@RequestMapping`

RequestMapping是一个用来处理请求地址映射的注解，可用于类或方法上。

用于类上，表示类中的所有响应请求的方法都是以该地址作为父路径。

@RequestMapping("/building")
public class BuildingController {
}

用于方法上: 提供进一步的细分映射信息

@RequestMapping("/building")
public class BuildingController {

	@RequestMapping(value = "/list/{communityId}")
	public BaseDTO list(@PathVariable String communityId ) {
	    // TODO
	}
}

常见属性：

value：指定请求的实际地址，指定的地址可以是URI Template 模式；
method：指定请求的method类型， GET、POST、PUT、DELETE等；
consumes：指定处理请求的提交内容类型（Content-Type），例如 application/json, text/html；
produces：指定返回的内容类型，仅当request请求头中的(Accept)类型中包含该指定类型才返回；
params：指定request中必须包含某些参数值时，才让该方法处理。
headers：指定request中必须包含某些指定的header值，才能让该方法处理请求。

3. `@Resource 和 @Autowired`

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

1、共同点

两者都可以写在字段和setter方法上。两者如果都写在类上，那么就不需要再写setter方法。而且常用的也是注解在类上(因为程序员懒得写setter方法)

2、不同点

（1）@Autowired

@Autowired为Spring提供的注解，需要导入包org.springframework.beans.factory.annotation.Autowired;只按照byType注入。全注解形式使用注解配置bean，使用注解配置注入，单单写一个@Autowired是不能实现自动注入的，因为没有开启扫包配置注解，只有component-scan base-package="…"后。才能实现注解使用，然后只有使用了@Component这个注解的成员变量才会自动生成对象，然后才能自动注入。

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

@Autowired注解是按照类型（byType）装配依赖对象，默认情况下它要求依赖对象必须存在，如果允许null值，可以设置它的required属性为false。如果我们想使用按照名称（byName）来装配，可以结合@Qualifier注解一起使用。如下：

public class TestServiceImpl {
    @Autowired
    @Qualifier("userDao")
    private UserDao userDao; 
}

（2）@Resource

@Resource默认按照ByName自动注入，由J2EE提供，需要导入包javax.annotation.Resource。@Resource有两个重要的属性：name和type，而Spring将@Resource注解的name属性解析为bean的名字，而type属性则解析为bean的类型。所以，如果使用name属性，则使用byName的自动注入策略，而使用type属性时则使用byType自动注入策略。如果既不制定name也不制定type属性，这时将通过反射机制使用byName自动注入策略。

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

注：最好是将@Resource放在setter方法上，因为这样更符合面向对象的思想，通过set、get去操作属性，而不是直接去操作属性。

@Resource装配顺序：

如果同时指定了name和type —— 则从Spring上下文中找到唯一匹配的bean进行装配，找不到则抛出异常。
如果指定了name —— 则从上下文中查找名称（id）匹配的bean进行装配，找不到则抛出异常。
如果指定了type —— 则从上下文中找到类似匹配的唯一bean进行装配，找不到或是找到多个，都会抛出异常。
如果既没有指定name，又没有指定type —— 则自动按照byName方式进行装配；如果没有匹配，则回退为一个原始类型进行匹配，如果匹配则自动装配。

@Resource的作用相当于@Autowired，只不过@Autowired按照byType自动注入。

4. `@ModelAttribute 和 @SessionAttributes`

代表的是：该Controller的所有方法在调用前，先执行此@ModelAttribute方法，可用于注解和方法参数中，可以把这个@ModelAttribute特性，应用在BaseController当中，所有的Controller继承BaseController，即可实现在调用Controller时，先执行@ModelAttribute方法。

@SessionAttributes即将值放到session作用域中，写在class上面。

5. `@PathVariable`

用于将请求URL中的模板变量映射到功能处理方法的参数上，即取出URI模板中的变量作为参数。如：

@Controller  
public class TestController {  
     @RequestMapping(value="/user/{userId}/roles/{roleId}",method = RequestMethod.GET)  
     public String getLogin(@PathVariable("userId") String userId,  
         @PathVariable("roleId") String roleId){  
         System.out.println("User Id : " + userId);  
         System.out.println("Role Id : " + roleId);  
         return "hello";  
     }  
     @RequestMapping(value="/product/{productId}",method = RequestMethod.GET)  
     public String getProduct(@PathVariable("productId") String productId){  
           System.out.println("Product Id : " + productId);  
           return "hello";  
     }  
     @RequestMapping(value="/javabeat/{regexp1:[a-z-]+}",  
           method = RequestMethod.GET)  
     public String getRegExp(@PathVariable("regexp1") String regexp1){  
           System.out.println("URI Part 1 : " + regexp1);  
           return "hello";  
     }  
}

6. `@requestParam`

@requestParam主要用于在SpringMVC后台控制层获取参数，类似一种是request.getParameter("name")，它有三个常用参数：defaultValue = “0”, required = false, value = “isApp”；defaultValue 表示设置默认值，required 铜过boolean设置是否是必须要传入的参数，value 值表示接受的传入的参数类型。

7. `@ResponseBody`

作用：该注解用于将Controller的方法返回的对象，通过适当的HttpMessageConverter转换为指定格式后，写入到Response对象的body数据区。

使用时机：返回的数据不是html标签的页面，而是其他某种格式的数据时（如json、xml等）使用；

8. `@Component`

相当于通用的注解，当不知道一些类归到哪个层时使用，但是不建议。

9. `@Repository`

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

10. `@service`

用于注解service层

呼卓宇

关注

5
点赞
踩
15

收藏

觉得还不错? 一键收藏
0
评论
Spring MVC常用注解

Spring MVC常用注解1. @Controller在SpringMVC 中，控制器Controller负责处理由DispatcherServlet分发的请求，它把用户请求的数据经过业务处理层处理之后封装成一个Model ，然后再把该Model返回给对应的View进行展示。在SpringMVC 中提供了一个非常简便的定义Controller的方法，你无需继承特定的类或实现特定的接口，...
复制链接

扫一扫