modelattribute注解的作用_Spring 家族常用注解

最新推荐文章于 2026-05-22 12:30:35 发布

原创最新推荐文章于 2026-05-22 12:30:35 发布 · 2.4k 阅读

8 ·

本内容遵循CC 4.0 BY-SA版权协议

标签

#modelattribute注解的作用

本文详细介绍了Spring框架中常用的注解，包括Spring、SpringMVC和SpringBoot中的注解，涵盖了从基本的组件扫描到复杂的自动配置等内容。

常用注解

1 Spring 常用注解

1.11 将实体类存入Spring的IOC容器:

1.1.1 @Component

@Component 用于创建bean对象，此类注解主要注解在类上，将该类注入到Spring容器中，使其成为容器的组件。表示注解的类交给Spring管理，需要Spring为这个类创建bean，等同于XML文件中配置，属性：value 用于指定bean的id，当不写时，默认值为类名的驼峰命令。

@Component ：标准一个普通的spring Bean类。
@Repository：标注一个DAO组件类。
@Service：标注一个业务逻辑组件类。
@Controller：标注一个控制器组件类。

这些都是注解在平时的开发过程中出镜率极高，@Component、@Repository、@Service、@Controller实质上属于同一类注解，用法相同，功能相同，区别在于标识组件的类型。@Component可以代替@Repository、@Service、@Controller，因为这三个注解是被@Component标注的。由@Componen注解衍生的三个注解(本质是@Component)是@Controller 一般用于表现的注解、@Service 一般用于业务层。@Repository 一般用于持久层‘。

1.1.2 @Bean

作用：用于把当前方法的返回值作为bean对象存入spring的ioc容器中属性:name:用于指定bean的id。当不写时，默认值是当前方法的名称细节：当我们使用注解配置方法时，如果方法有参数，spring框架会去容器中查找有没有可用的bean对象。查找的方式和Autowired注解的作用是一样的

1.2 用于注入数据的:

1.2.1 @Autowired/@Resource(非Spring注解，但支持使用):

@Autowired

@Autowired 注解，它可以对类成员变量、方法及构造函数进行标注，完成自动装配的工作。自动按照类型注入。当使用注解注入属性时， set/get 方法可以省略。它只能注入其他 bean 类型。当有多个类型匹配时，使用要注入的对象变量名称作为 bean 的 id，在 spring 容器查找，找到了也可以注入成功。找不到就报错。通过 @Autowired的使用来消除 set /get方法。如果我们想使用名称装配可以结合@Qualifier注解进行使用，如下@Autowired() @Qualifier("baseDao") private BaseDao baseDao;

@Resource:作用：直接按照 Bean 的 id 注入。它也只能注入其他 bean 类型。属性：name：指定 bean 的 id。@Resource默认按照ByName自动注入，由J2EE提供，需要导入包javax.annotation.Resource。@Resource有两个重要的属性：name和type，而Spring将@Resource注解的name属性解析为bean的名字，而type属性则解析为bean的类型。

注意：@Autowired与@Resource都可以用来装配bean. 都可以写在字段上,或写在setter方法上。@Autowired 根据类型注入， @Resource 默认根据名字注入，其次按照类型搜索。@Autowired @Qualifie("userService") 两个结合起来可以根据名字和类型注入，@Autowired+@Qualifie=@Resource。

1.2.2 @Qualifier

作用:在自动按照类型注入的基础之上，再按照 Bean 的 id 注入。它在给字段注入时不能独立使用，必须和@Autowired使用，指定多个相同类型的具体一个类型注入；给方法的形参注入数据时，可以独立使用。属性：value用于指定bean的id

1.2.3 @Value

作用：注入基本数据类型和 String 类型数据的属性：value：用于指定值

1.3 改变作用范围的:

1.3.1 @Scope

作用：指定 bean 的作用范围。属性：value：指定范围的值。取值：singleton(单例的) prototype(多例的)request(每次http请求都会创建一个bean，该作用域仅在基于web的Spring ApplicationContext情形下有效。)session (在一个HTTP Session中，一个bean定义对应一个实例。该作用域仅在基于web的Spring ApplicationContext情形下有效。)globalsession(在一个全局的HTTP Session中，一个bean定义对应一个实例。该作用域仅在基于web的Spring ApplicationContext情形下有效。)缺省的Spring bean 的作用域是Singleton.

1.4 和生命周期相关的：

1.4.1 @PostConstruct

作用：用于指定初始化方法

1.4.2 @PreDestroy

作用：用于指定销毁方法

1.5 配置类相关:

1.5.1 @Configuration

作用：@Configuration用于定义配置类，可替换xml配置文件，被注解的类内部包含有一个或多个被@Bean注解的方法，这些方法将会被AnnotationConfigApplicationContext或AnnotationConfigWebApplicationContext类进行扫描，并用于构建bean定义，初始化Spring容器，指定当前类是一个 spring 配置类，当创建容器时会从该类上加载注解。细节:当配置类作为AnnotationConfigApplicationContext对象创建的参数时，该注解可以不写。

1.5.2 @ComponentScan

作用：用于指定 spring 在初始化容器时要扫描的包。作用和在 spring 的 xml 配置文件中的：是一样的。

属性：basePackages：用于指定要扫描的包。和该注解中的 value 属性作用一样。

1.5.3 @Import

作用：用于导入其他的配置类属性：value：用于指定其他配置类的字节码。当我们使用Import的注解之后，有Import注解的类就是父配置类，而导入的都是子配置类

2 SpringMVC 常用注解

2.1 @Controller

@Controller 用于标记在一个类上，使用它标记的类就是一个SpringMVC Controller 对象。分发处理器将会扫描使用了该注解的类的方法，并检测该方法是否使用了@RequestMapping 注解。@Controller 只是定义了一个控制器类，而使用@RequestMapping 注解的方法才是真正处理请求的处理器。在SpringMVC 中，控制器Controller 负责处理由DispatcherServlet 分发的请求，它把用户请求的数据经过业务处理层处理之后封装成一个Model ，然后再把该Model 返回给对应的View 进行展示。在SpringMVC 中提供了一个非常简便的定义Controller 的方法，你无需继承特定的类或实现特定的接口，只需使用@Controller 标记一个类是Controller ，然后使用@RequestMapping 和@RequestParam 等一些注解用以定义URL 请求和Controller 方法之间的映射，这样的Controller 就能被外界访问到。

2.2 @RequestMapping

RequestMapping是一个用来处理请求地址映射的注解，可用于类或方法上。用于类上，表示类中的所有响应请求的方法都是以该地址作为父路径。当@RequestMapping 标记在Controller 类上的时候，里面使用@RequestMapping 标记的方法的请求地址都是相对于类上的@RequestMapping 而言的；当Controller 类上没有标记@RequestMapping 注解时，方法上的@RequestMapping 都是绝对路径。这种绝对路径和相对路径所组合成的最终路径都是相对于根路径“/ ”而言的。

@GetMapping 等同于 @RequestMapping(method = RequestMethod.GET)@PostMapping 等同于 @RequestMapping(method = RequestMethod.POST)@PutMapping 等同于 @RequestMapping(method = RequestMethod.PUT)@DeleteMapping 等同于 @RequestMapping(method = RequestMethod.DELETE)@PatchMapping 等同于 @RequestMapping(method = RequestMethod.PATCH)

2.3 @ModelAttribute和 @SessionAttributes

@ModelAttribute：作用于方法或参数上的注解，把数据或对象添加进Model对象。

@SessionAttributes：作用于Controller类，让Controller所有方法共享Model对象中一个或多个属性。

@SessionAttributes有两个属性，value和type，用于指定key和数据类型，可以多值，如@SessionAttributes(types = {User.class,Dept.class},value={“attr1”,”attr2”})

该Controller的所有方法在调用前，先执行此@ModelAttribute方法，可用于注解和方法参数中，可以把这个@ModelAttribute特性，应用在BaseController当中，所有的Controller继承BaseController，即可实现在调用Controller时，先执行@ModelAttribute方法。@SessionAttributes即将值放到session作用域中，写在class上面。

2.4 @PathVariable/@requestParam

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

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

区别：

@RequestParam 和 @PathVariable 注解是用于从request中接收请求的，两个都可以接收参数，关键点不同的是 @RequestParam 是从request里面拿取值，而 @PathVariable 是从一个URI模板里面来填充

2.5 @ResponseBody

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

2.6 @ControllerAdvice

@ControllerAdvice：可以被扫描到，统一处理异常。@ControllerAdvice ，是一个增强的 Controller，包含@Component。使用这个 Controller ，可以实现三个方面的功能：

全局异常处理
全局数据绑定
全局数据预处理

@ExceptionHandler(Exception.class)：用在方法上面表示遇到这个异常就执行以下方法。

3 SpringBoot 常用注解

3.1 @SpringBootApplication

此注解是个组合注解，包括了@SpringBootConfiguration，@EnableAutoConfiguration和@ComponentScan注解。@SpringBootConfiguration 继承至@Configuration，对于熟悉spring的开发者而言，此标注当前类是配置类，并会将当前类内声明的一个或多个以@Bean注解标记的方法的实例纳入到srping容器中，并且实例名就是方法名。@EnableAutoConfiguration 这个注解就是springboot能自动进行配置的魔法所在了。主要是通过此注解，能所有符合自动配置条件的bean的定义加载到spring容器中，比如根据spring-boot-starter-web ，来判断你的项目是否需要添加了webmvc和tomcat，就会自动的帮你配置web项目中所需要的默认配置。具体的使用，会在后期自定义实现一个自动启动类时，会讲解到它的一些机制。此章节就不深入了，只需要它是这个用途即可，一般上也单独使用不要这个注解，但比如需要排除一些无需自动配置的类时，可利用exclude进行排除@ComponentScan 这个熟悉spring的开发者也应该熟悉，会扫描当前包及其子包下被@Component，@Controller，@Service，@Repository等注解标记的类并纳入到spring容器中进行管理。

3.2 @SpringBootConfiguration

@SpringBootConfiguration继承自@Configuration，二者功能也一致，标注当前类是配置类，并会将当前类内声明的一个或多个以@Bean注解标记的方法的实例纳入到spring容器中，并且实例名就是方法名。

3.3 @EnableAutoConfiguration

@EnableAutoConfiguration也是借助@Import的帮助，将所有符合自动配置条件的bean定义加载到IoC容器，仅此而已！@EnableAutoConfiguration会根据类路径中的jar依赖为项目进行自动配置。这个注解告诉Spring Boot根据添加的jar依赖猜测你想如何配置Spring。由于 spring-boot-starter-web 添加了Tomcat和Spring MVC，所以auto-configuration将假定你正在开发一个web应用并相应地对Spring进行设置。Starter POMs和Auto-Configuration：设计auto-configuration的目的是更好的使用"Starter POMs"，但这两个概念没有直接的联系。你可以自由地挑选starter POMs以外的jar依赖，并且Spring Boot将仍旧尽最大努力去自动配置你的应用。你可以通过将 @EnableAutoConfiguration 或 @SpringBootApplication 注解添加到一个 @Configuration 类上来选择自动配置。

注：你只需要添加一个 @EnableAutoConfiguration 注解。我们建议你将它添加到主 @Configuration 类上。

如果发现应用了你不想要的特定自动配置类，你可以使用 @EnableAutoConfiguration 注解的排除属性来禁用它们。

3.4 @ComponentScan

@ComponentScan会扫描指定路径下的的类，并将其加入到Ioc容器中。在springboot中，@ComponentScan默认扫描@SpringBootApplication所在类的同级目录以及它的子目录。也可以使用@ComponentScan(basePackageClasses = com.qingtian.web.controller)来制定扫描包路径。@ComponentScan这个注解在Spring中很重要，它对应XML配置中的元素，@ComponentScan的功能其实就是自动扫描并加载符合条件的组件(比如@Component和@Repository等)或者bean定义，最终将这些bean定义加载到IoC容器中。

3.5 @RestController

@RestController 是Spring4之后加入的注解，原来在@Controller中返回json需要@ResponseBody来配合，如果直接用@RestController替代@Controller就不需要再配置@ResponseBody，默认返回json格式。当你实现一个RESTful web services的时候，response将一直通过response body发送。为了简化开发，Spring 4.0提供了一个专门版本的controller。

3.6 RequestMapping

RequestMapping是一个用来处理请求地址映射的注解，可用于类或方法上。用于类上，表示类中的所有响应请求的方法都是以该地址作为父路径。当@RequestMapping 标记在Controller 类上的时候，里面使用@RequestMapping 标记的方法的请求地址都是相对于类上的@RequestMapping 而言的；当Controller 类上没有标记@RequestMapping 注解时，方法上的@RequestMapping 都是绝对路径。这种绝对路径和相对路径所组合成的最终路径都是相对于根路径“/ ”而言的。

3.7 @Profiles

Spring Profiles提供了一种隔离应用程序配置的方式，并让这些配置只能在特定的环境下生效。任何@Component或@Configuration都能被@Profile标记，从而限制加载它的时机。

===============END=================