首页>>后端>>Spring->springmvc常用注解以及作用(springmvc常用注解都有哪些)

springmvc常用注解以及作用(springmvc常用注解都有哪些)

时间:2023-12-02 本站 点击:0

spring常用的注解有哪些

《spring常用的注解》百度网盘资源下载链接:

提取码: ida4   

注解本身没有功能的,就和 xml 一样。注解和 xml 都是一种元数据,元数据即解释数据的数据,这就是所谓配置。本文主要罗列 Spring|Spring MVC相关注解的简介。

spring常用注解有哪些

spring常用注解

链接:

提取码: vbp5   

注解本身没有功能的,就和 xml 一样。注解和 xml 都是一种元数据,元数据即解释数据的数据,这就是所谓配置。

springmvc的注解都有哪些

spring mvc常用的注解:

@Controller

@Controller 负责注册一个bean 到spring 上下文中,bean 的ID 默认为

类名称开头字母小写,你也可以自己指定,如下

方法一:

@Controller

public class TestController {}

方法二:

@Controller("tmpController")

public class TestController {}

@RequestMapping

1.@RequestMapping用来定义访问的URL,你可以为整个类定义一个

@RequestMapping,或者为每个方法指定一个。

把@RequestMapping放在类级别上,这可令它与方法级别上的

@RequestMapping注解协同工作,取得缩小选择范围的效果。

例如:

@RequestMapping("/test")

public class TestController {}

则,该类下的所有访问路径都在/test之下。

2.将@RequestMapping用于整个类不是必须的,如果没有配置,所有的方法

的访问路径配置将是完全独立的,没有任何关联。

3.完整的参数项为:@RequestMapping(value="",method =

{"",""},headers={},params={"",""}),各参数说明如下:

value :String[] 设置访问地址

method: RequestMethod[]设置访问方式,字符数组,查看RequestMethod

类,包括GET, HEAD, POST, PUT, DELETE, OPTIONS, TRACE,常用

RequestMethod.GET,RequestMethod.POST

headers:String[] headers一般结合method = RequestMethod.POST使用

params: String[] 访问参数设置,字符数组 例如:userId=id

4.value的配置还可以采用模版变量的形式 ,例如:@RequestMapping

(value="/owners/{ownerId}", method=RequestMethod.GET),这点将在介

绍@PathVariable中详细说明。

5.@RequestMapping params的补充说明,你可以通过设置参数条件来限制

访问地址,例如params="myParam=myValue"表达式,访问地址中参数只有

包含了该规定的值"myParam=myValue"才能匹配得上,类似"myParam"之类

的表达式也是支持的,表示当前请求的地址必须有该参数(参数的值可以是

任意),"!myParam"之类的表达式表明当前请求的地址不能包含具体指定的

参数"myParam"。

6.有一点需要注意的,如果为类定义了访问地址为*.do,*.html之类的,则

在方法级的@RequestMapping,不能再定义value值,否则会报错,例如

Java代码

@RequestMapping("/bbs.do")

public class BbsController {

@RequestMapping(params = "method=getList")

public String getList() {

return "list";

}

@RequestMapping(value= "/spList")

public String getSpecialList() {

return "splist";

}

}

如上例:/bbs.do?method=getList 可以访问到方法getList() ;而访

问/bbs.do/spList则会报错.

@PathVariable

1.@PathVariable用于方法中的参数,表示方法参数绑定到地址URL的模板

变量。

例如:

Java代码

@RequestMapping(value="/owners/{ownerId}",

method=RequestMethod.GET)

public String findOwner(@PathVariable String ownerId, Model

model) {

Owner owner = ownerService.findOwner(ownerId);

model.addAttribute("owner", owner);

return "displayOwner";

}

2.@PathVariable用于地址栏使用{xxx}模版变量时使用。

如果@RequestMapping没有定义类似"/{ownerId}" ,这种变量,则使用在

方法中@PathVariable会报错。

@ModelAttribute

1.应用于方法参数,参数可以在页面直接获取,相当于

request.setAttribute(,)

2.应用于方法,将任何一个拥有返回值的方法标注上 @ModelAttribute,使

其返回值将会进入到模型对象的属性列表中.

3.应用于方法参数时@ModelAttribute("xx"),须关联到Object的数据类型

,基本数据类型 如:int,String不起作用

例如:

Java代码

@ModelAttribute("items")//——①向模型对象中添加一个名为items的

属性

public ListString populateItems() {

ListString lists = new ArrayListString();

lists.add("item1");

lists.add("item2");

return lists;

}

@RequestMapping(params = "method=listAllBoard")

public String listAllBoard(@ModelAttribute("currUser")User user,

ModelMap model) {

bbtForumService.getAllBoard();

//——②在此访问模型中的items属性

System.out.println("model.items:" + ((ListString)

model.get("items")).size());

return "listBoard";

}

在 ① 处,通过使用 @ModelAttribute 注解,populateItem() 方法将在

任何请求处理方法执行前调用,Spring MVC 会将该方法返回值以“items

”为名放入到隐含的模型对象属性列表中。

所以在 ② 处,我们就可以通过 ModelMap 入参访问到 items 属性,当执

行 listAllBoard() 请求处理方法时,② 处将在控制台打印

出“model.items:2”的信息。当然我们也可以在请求的视图中访问到模型

对象中的 items 属性。

@ResponseBody

这个注解可以直接放在方法上,表示返回类型将会直接作为HTTP响应字节

流输出(不被放置在Model,也不被拦截为视图页面名称)。可以用于ajax。

@RequestParam

@RequestParam是一个可选参数,例如:@RequestParam("id") 注解,所以

它将和URL所带参数 id进行绑定

如果入参是基本数据类型(如 int、long、float 等),URL 请求参数中

一定要有对应的参数,否则将抛出

org.springframework.web.util.NestedServletException 异常,提示无

法将 null 转换为基本数据类型.

@RequestParam包含3个配置 @RequestParam(required = ,value="",

defaultValue = "")

required :参数是否必须,boolean类型,可选项,默认为true

value: 传递的参数名称,String类型,可选项,如果有值,对应到设置方

法的参数

defaultValue:String类型,参数没有传递时为参数默认指定的值

@SessionAttributes session管理

Spring 允许我们有选择地指定 ModelMap 中的哪些属性需要转存到

session 中,以便下一个请求属对应的 ModelMap 的属性列表中还能访问

到这些属性。这一功能是通过类定义处标注 @SessionAttributes 注解来

实现的。@SessionAttributes 只能声明在类上,而不能声明在方法上。

例如

@SessionAttributes("currUser") // 将ModelMap 中属性名为currUser 的属性

@SessionAttributes({"attr1","attr2"})

@SessionAttributes(types = User.class)

@SessionAttributes(types = {User.class,Dept.class})

@SessionAttributes(types = {User.class,Dept.class},value={"attr1","attr2"})

@CookieValue 获取cookie信息

@RequestHeader 获取请求的头部信息

Spring 常用注解大全

@Controller:组合注解(组合了@Component注解),应用在Controller层(控制层)。

@Service:组合注解(组合了@Component注解),应用在Service层(业务逻辑层)。

@Reponsitory:组合注解(组合了@Component注解),应用在Dao层(数据访问层)。

@Component:表示类是一个“组件”,成为Spring管理的Bean。同时@Component还是一个元注解。

@Autowired:Spring提供的工具(由Spring的依赖注入工具BeanPostProcessor或BeanFactoryPostProcessor自动注入)。

@Resource:JSR-250提供的注解。

@Inject:JSR-330提供的注解。

@Configuration:声明当前类是一个配置类(相当于一个Spring配置文件)。

@ComponentScan:自动扫描指定包下所有使用@Service,@Component,@Controller,@Repository的类并注册。

@Bean:注解在方法上,声明当前方法的返回值为一个Bean。返回的Bean对应的类中可以定义init()方法和destroy()方法,然后在@Bean(initMethod=”init”, destroyMethod=”destroy”)定义,在构造之后执行init,在销毁之前执行destroy。

@Aspect:声明一个切面。

@After:后置建言(advice),在原方法前执行。

@Before:前置建言(advice),在原方法后执行。

@Around:环绕建言(advice),在原方法执行前执行,在原方法执行后再执行。

@PointCut:声明切点,即定义拦截规则,确定有哪些方法会被切入。

@Transactional:声明事务(一般默认配置即可满足要求,当然也可以自定义)。

@Cacheable:声明数据缓存。

@EnableAspectJAutoProxy:开启Spring对AspectJ的支持。

@Value:值得注入。经常与Sping EL表达式语言一起使用,注入普通字符,系统属性,表达式运算结果,其他Bean的属性,文件内容,网址请求内容,配置文件属性值等。

@PropertySource:指定文件地址。提供了一种方便的、声明性的机制,用于向Spring的环境添加PropertySource。与@Configuration类一起使用。

@PostConstruct:标注在方法上,该方法在构造函数执行完成之后执行。

@PreDestroy:标注在方法上,该方法在对象销毁之前执行。

@Profile:表示当一个或多个指定的文件是活动的时,一个组件是有资格注册的。使用@Profile注解类或者方法,达到在不同情况下选择实例化不同的Bean。@Profile(“dev”)表示为dev时实例化。

@EnableAsync:开启异步任务支持。注解在配置类上。

@Async:注解在方法上表示这是一个异步方法,在类上表示这个类所有的方法都是异步方法。

@EnableScheduling:注解在配置类上,开启对计划任务的支持。

@Scheduled:注解在方法上,声明该方法是计划任务。支持多种类型的计划任务:cron,fixDelay,fixRate。

@Conditional:根据满足某一特定条件创建特定的Bean。

@Enable*:通过简单的@Enable*来开启一项功能的支持。所有@Enable*注解都有一个@Import注解,@Import是用来导入配置类的,这也就意味着这些自动开启的实现其实是导入了一些自动配置的Bean。

@RunWith:这个是Junit的注解,SpringBoot集成了junit。一般在测试类里使用:@RunWith(SpringJUnit4ClassRunner.class) — SpringJUnit4ClassRunner在JUnit环境下提供Sprng TestContext Framework的功能

@ContextConfiguration:用来加载配置ApplicationContext,其中classes属性用来加载配置类:@ContextConfiguration(classes = {TestConfig.class(自定义的一个配置类)})

@ActiveProfiles:用来声明活动的profile–@ActiveProfiles(“prod”(这个prod定义在配置类中))

@EnableWebMvc:用在配置类上,开启SpringMvc的Mvc的一些默认配置:如ViewResolver,MessageConverter等。同时在自己定制SpringMvc的相关配置时需要做到两点:1:配置类继承WebMvcConfigurerAdapter类,2:就是必须使用这个@EnableWebMvc注解。

@RequestMapping:用来映射web请求(访问路径和参数),处理类和方法的。可以注解在类和方法上,注解在方法上的@RequestMapping路径会继承注解在类上的路径。同时支持Serlvet的request和response作为参数,也支持对request和response的媒体类型进行配置。其中有value(路径),produces(定义返回的媒体类型和字符集),method(指定请求方式)等属性。

@ResponseBody:将返回值放在response体内。返回的是数据而不是页面

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

@PathVariable:放置在参数前,用来接受路径参数。

@RestController:组合注解,组合了@Controller和@ResponseBody,当我们只开发一个和页面交互数据的控制层的时候可以使用此注解。

@ControllerAdvice:用在类上,声明一个控制器建言,它也组合了@Component注解,会自动注册为Spring的Bean。

@ExceptionHandler:用在方法上定义全局处理,通过他的value属性可以过滤拦截的条件:@ExceptionHandler(value=Exception.class)–表示拦截所有的Exception。

@ModelAttribute:将键值对添加到全局,所有注解了@RequestMapping的方法可获得次键值对(就是在请求到达之前,往model里addAttribute一对name-value而已)。

@InitBinder:通过@InitBinder注解定制WebDataBinder(用在方法上,方法有一个WebDataBinder作为参数,用WebDataBinder在方法内定制数据绑定,例如可以忽略request传过来的参数Id等)。

@WebAppConfiguration:一般用在测试上,注解在类上,用来声明加载的ApplicationContext是一个WebApplicationContext。他的属性指定的是Web资源的位置,默认为src/main/webapp,我们可以修改为:@WebAppConfiguration(“src/main/resources”)。

@EnableAutoConfiguration:此注释自动载入应用程序所需的所有Bean——这依赖于Spring Boot在类路径中的查找。该注解组合了@Import注解,@Import注解导入了EnableAutoCofigurationImportSelector类,它使用SpringFactoriesLoader.loaderFactoryNames方法来扫描具有META-INF/spring.factories文件的jar包。而spring.factories里声明了有哪些自动配置。

@SpingBootApplication:SpringBoot的核心注解,主要目的是开启自动配置。它也是一个组合注解,主要组合了@Configurer,@EnableAutoConfiguration(核心)和@ComponentScan。可以通过@SpringBootApplication(exclude={想要关闭的自动配置的类名.class})来关闭特定的自动配置。

@ImportResource:虽然Spring提倡零配置,但是还是提供了对xml文件的支持,这个注解就是用来加载xml配置的。例:@ImportResource({“classpath

@ConfigurationProperties:将properties属性与一个Bean及其属性相关联,从而实现类型安全的配置。例:@ConfigurationProperties(prefix=”authot”, locations={“classpath

@ConditionalOnBean:条件注解。当容器里有指定Bean的条件下。

@ConditionalOnClass:条件注解。当类路径下有指定的类的条件下。

@ConditionalOnExpression:条件注解。基于SpEL表达式作为判断条件。

@ConditionalOnJava:条件注解。基于JVM版本作为判断条件。

@ConditionalOnJndi:条件注解。在JNDI存在的条件下查找指定的位置。

@ConditionalOnMissingBean:条件注解。当容器里没有指定Bean的情况下。

@ConditionalOnMissingClass:条件注解。当类路径下没有指定的类的情况下。

@ConditionalOnNotWebApplication:条件注解。当前项目不是web项目的条件下。

@ConditionalOnResource:条件注解。类路径是否有指定的值。

@ConditionalOnSingleCandidate:条件注解。当指定Bean在容器中只有一个,后者虽然有多个但是指定首选的Bean。

@ConditionalOnWebApplication:条件注解。当前项目是web项目的情况下。

@EnableConfigurationProperties:注解在类上,声明开启属性注入,使用@Autowired注入。例:@EnableConfigurationProperties(HttpEncodingProperties.class)。

@AutoConfigureAfter:在指定的自动配置类之后再配置。例:@AutoConfigureAfter(WebMvcAutoConfiguration.class)。

转自:

spring mvc 常用注解详解

前言

现在主流的Web MVC框架除了Struts这个主力 外,其次就是Spring MVC了,因此这也是作为一名程序员需要掌握的主流框架,框架选择多了,应对多变的需求和业务时,可实行的方案自然就多了。不过要想灵活运用Spring MVC来应对大多数的Web开发,就必须要掌握它的配置及原理。

Spring mvc 介绍

Spring Web MVC是一种基于Java的实现了Web MVC设计模式的请求驱动类型的轻量级Web框架,即使用了MVC架构模式的思想,将web层进行职责解耦,基于请求驱动指的就是使用请求-响应模型,框架的目的就是帮助我们简化开发,Spring Web MVC也是要简化我们日常Web开发

image.png

spring mvc 常用注解详解

@Controller

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

@RequestMapping

RequestMapping是一个用来处理请求地址映射的注解,可用于类或方法上。用于类上,表示类中的所有响应请求的方法都是以该地址作为父路径,作用于方法上,表明该处理器的请求地址=父路径+方法上url+method,其拥有6个属性

1、 value, method;定义处理器访问的具体体质

value: 指定请求的实际地址,指定的地址可以是URI Template 模式;

method: 指定请求的method类型, GET、POST、PUT、DELETE等;

2、consumes,produces 定义处理器内容类型

consumes: 指定处理请求的提交内容类型(Content-Type),例如application/json, text/html;

produces: 指定返回的内容类型,仅当request请求头中的(Accept)类型中包含该指定类型才返回;

3、params,headers 定义处理器处理类型

params: 指定request中必须包含某些参数值,才让该方法处理!

headers: 指定request中必须包含某些指定的header值,才能让该方法处理请求。

@PathVariable

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

@requestParam

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

@ResponseBody

作用: 该注解用于将Controller的方法返回的对象,通过适当的HttpMessageConverter转换为指定格式后,写入到Response对象的body数据区。使用时机:返回的数据不是html标签的页面,而是其他某种格式的数据时(如json等)使用;

@RequestBody

该注解常用来处理Content-Type: 不是application/x-www-form-urlencoded编码的内容,例如application/json, application/xml等;它是通过使用HandlerAdapter 配置的HttpMessageConverters来解析post data body,然后绑定到相应的bean上的。

spring mvc 拦截器配置

preHandle:预处理回调方法,返回值:true表示继续流程,false表示流程中断(如登录检查失败),不会继续续调用其他的拦截器或处理器,此时我们需要通过response来产生响应;

postHandle:后处理回调方法,实现处理器的后处理(但在渲染视图之前),此时我们可以通过modelAndView(模型和视图对象)对模型数据进行处理或对视图进行处理,modelAndView也可能为null。

afterCompletion:整个请求处理完毕回调方法,即在视图渲染完毕时回调,如性能监控中我们可以在此记录结束时间并输出消耗时间,还可以进行一些资源清理,类似于try-catch-finally中的finally,但仅调用处理器执行链中preHandle返回true的拦截器的afterCompletion。

spring mvc 静态资源放问配置

image.png

spring mvc 文件上传

前端

后端

spring mvc 工作流程详解

image.png

1、 用户发送请求至前端控制器DispatcherServlet。

2、 DispatcherServlet收到请求调用HandlerMapping处理器映射器。

3、 处理器映射器找到具体的处理器(可以根据xml配置、注解进行查找),生成处理器对象及处理器拦截器(如果有则生成)一并返回给DispatcherServlet。

4、 DispatcherServlet调用HandlerAdapter处理器适配器。

5、 HandlerAdapter经过适配调用具体的处理器(Controller,也叫后端控制器)。

6、 Controller执行完成返回ModelAndView。

7、 HandlerAdapter将controller执行结果ModelAndView返回给DispatcherServlet。

8、 DispatcherServlet将ModelAndView传给ViewReslover视图解析器。

9、 ViewReslover解析后返回具体View。

10、DispatcherServlet根据View进行渲染视图(即将模型数据填充至视图中)。

11、 DispatcherServlet响应用户。

如果你也对Java架构比如分布式、微服务、源码分析、性能优化、高并发高可用等技术感兴趣可以在手机上面私信我,回复「架构」二字即可免费领取一套价值3880的架构资料哦。


本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。
如若转载,请注明出处:/Spring/10010.html