spring boot 的常用注解使用小结
@restcontroller和@requestmapping注解
4.0重要的一个新的改进是@restcontroller注解,它继承自@controller注解。4.0之前的版本,spring mvc的组件都使用@controller来标识当前类是一个控制器servlet。使用这个特性,我们可以开发rest服务的时候不需要使用@controller而专门的@restcontroller。
当你实现一个restful web services的时候,response将一直通过response body发送。为了简化开发,spring 4.0提供了一个专门版本的controller。下面我们来看看@restcontroller实现的定义:
@target(value=type) @retention(value=runtime) @documented @controller @responsebody public @interface restcontroller @target(value=type) @retention(value=runtime) @documented @controller @responsebody public @interface restcontroller
@requestmapping 注解提供路由信息。它告诉spring任何来自"/"路径的http请求都应该被映射到 home 方法。 @restcontroller 注解告诉spring以字符串的形式渲染结果,并直接返回给调用者。
注: @restcontroller 和 @requestmapping 注解是spring mvc注解(它们不是spring boot的特定部分)
@enableautoconfiguration注解
第二个类级别的注解是 @enableautoconfiguration 。这个注解告诉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 注解的排除属性来禁用它们。
<pre name="code" class="java">import org.springframework.boot.autoconfigure.*; import org.springframework.boot.autoconfigure.jdbc.*; import org.springframework.context.annotation.*; @configuration @enableautoconfiguration(exclude={datasourceautoconfiguration.class}) public class myconfiguration { } <pre name="code" class="java">import org.springframework.boot.autoconfigure.*; import org.springframework.boot.autoconfigure.jdbc.*; import org.springframework.context.annotation.*; @configuration @enableautoconfiguration(exclude={datasourceautoconfiguration.class}) public class myconfiguration { } @configuration
spring boot提倡基于java的配置。尽管你可以使用一个xml源来调用 springapplication.run() ,我们通常建议你使用 @configuration 类作为主要源。一般定义 main 方法的类也是主要 @configuration 的一个很好候选。你不需要将所有的 @configuration 放进一个单独的类。 @import 注解可以用来导入其他配置类。另外,你也可以使用 @componentscan 注解自动收集所有的spring组件,包括 @configuration 类。
如果你绝对需要使用基于xml的配置,我们建议你仍旧从一个 @configuration 类开始。你可以使用附加的 @importresource 注解加载xml配置文件。
@configuration注解该类,等价 与xml中配置beans;用@bean标注方法等价于xml中配置bean
@componentscan(basepackages = "com.hyxt",includefilters = {@componentscan.filter(aspect.class)}) @componentscan(basepackages = "com.hyxt",includefilters = {@componentscan.filter(aspect.class)}) @springbootapplication
很多spring boot开发者总是使用 @configuration , @enableautoconfiguration 和 @componentscan 注解他们的main类。由于这些注解被如此频繁地一块使用(特别是你遵循以上最佳实践时),spring boot提供一个方便的 @springbootapplication 选择。
该 @springbootapplication 注解等价于以默认属性使用 @configuration , @enableautoconfiguration 和 @componentscan 。
package com.example.myproject; import org.springframework.boot.springapplication; import org.springframework.boot.autoconfigure.springbootapplication; @springbootapplication // same as @configuration @enableautoconfiguration @componentscan public class application { public static void main(string[] args) { springapplication.run(application.class, args); } } package com.example.myproject; import org.springframework.boot.springapplication; import org.springframework.boot.autoconfigure.springbootapplication; @springbootapplication // same as @configuration @enableautoconfiguration @componentscan public class application { public static void main(string[] args) { springapplication.run(application.class, args); } }
spring boot将尝试校验外部的配置,默认使用jsr-303(如果在classpath路径中)。你可以轻松的为你的@configurationproperties类添加jsr-303 javax.validation约束注解:
@component @configurationproperties(prefix="connection") public class connectionsettings { @notnull private inetaddress remoteaddress; // ... getters and setters } @component @configurationproperties(prefix="connection") public class connectionsettings { @notnull private inetaddress remoteaddress; // ... getters and setters } @profiles spring profiles提供了一种隔离应用程序配置的方式,并让这些配置只能在特定的环境下生效。任何@component或@configuration都能被@profile标记,从而限制加载它的时机。 [java] view plain copy print?在code上查看代码片派生到我的代码片 @configuration @profile("production") public class productionconfiguration { // ... } @configuration @profile("production") public class productionconfiguration { // ... }@responsebody
表示该方法的返回结果直接写入http response body中
一般在异步获取数据时使用,在使用@requestmapping后,返回值通常解析为跳转路径,加上
@responsebody后返回结果不会被解析为跳转路径,而是直接写入http response body中。比如
异步获取json数据,加上@responsebody后,会直接返回json数据。
@component:
泛指组件,当组件不好归类的时候,我们可以使用这个注解进行标注。一般公共的方法我会用上这个注解
@autowired
bytype方式。把配置好的bean拿来用,完成属性、方法的组装,它可以对类成员变量、方法及构
造函数进行标注,完成自动装配的工作。
当加上(required=false)时,就算找不到bean也不报错。
@requestparam:
用在方法的参数前面。
@requestparam string a =request.getparameter("a")。 @requestparam string a =request.getparameter("a")。
@pathvariable:
路径变量。
requestmapping("user/get/mac/{macaddress}") public string getbymacaddress(@pathvariable string macaddress){ //do something; } requestmapping("user/get/mac/{macaddress}") public string getbymacaddress(@pathvariable string macaddress){ //do something; }
参数与大括号里的名字一样要相同。
以上注解的示范
/** * 用户进行评论及对评论进行管理的 controller 类; */ @controller @requestmapping("/msgcenter") public class mycommentcontroller extends basecontroller { @autowired commentservice commentservice; @autowired operatorservice operatorservice; /** * 添加活动评论; * * @param applyid 活动 id; * @param content 评论内容; * @return */ @responsebody @requestmapping("/addcomment") public map<string, object> addcomment(@requestparam("applyid") integer applyid, @requestparam("content") string content) { .... return result; } } /** * 用户进行评论及对评论进行管理的 controller 类; */ @controller @requestmapping("/msgcenter") public class mycommentcontroller extends basecontroller { @autowired commentservice commentservice; @autowired operatorservice operatorservice; /** * 添加活动评论; * * @param applyid 活动 id; * @param content 评论内容; * @return */ @responsebody @requestmapping("/addcomment") public map<string, object> addcomment(@requestparam("applyid") integer applyid, @requestparam("content") string content) { .... return result; } } @requestmapping("/list/{applyid}") public string list(@pathvariable long applyid, httpservletrequest request, modelmap modelmap) { } @requestmapping("/list/{applyid}") public string list(@pathvariable long applyid, httpservletrequest request, modelmap modelmap) { }
全局处理异常的:
@controlleradvice:
包含@component。可以被扫描到。
统一处理异常。
@exceptionhandler(exception.class):
用在方法上面表示遇到这个异常就执行以下方法。
/** * 全局异常处理 */ @controlleradvice class globaldefaultexceptionhandler { public static final string default_error_view = "error"; @exceptionhandler({typemismatchexception.class,numberformatexception.class}) public modelandview formaterrorhandler(httpservletrequest req, exception e) throws exception { modelandview mav = new modelandview(); mav.addobject("error","参数类型错误"); mav.addobject("exception", e); mav.addobject("url", requestutils.getcompleterequesturl(req)); mav.addobject("timestamp", new date()); mav.setviewname(default_error_view); return mav; }} /** * 全局异常处理 */ @controlleradvice class globaldefaultexceptionhandler { public static final string default_error_view = "error"; @exceptionhandler({typemismatchexception.class,numberformatexception.class}) public modelandview formaterrorhandler(httpservletrequest req, exception e) throws exception { modelandview mav = new modelandview(); mav.addobject("error","参数类型错误"); mav.addobject("exception", e); mav.addobject("url", requestutils.getcompleterequesturl(req)); mav.addobject("timestamp", new date()); mav.setviewname(default_error_view); return mav; }}
通过@value注解来读取application.properties里面的配置
# face++ key face_api_key = r9z3vxc7zcxfewgvrjoyrvu1d-qr**** face_api_secret =d9wuqgcylvocidsbx35uth******** # face++ key face_api_key = r9z3vxc7zcxfewgvrjoyrvu1d-qr**** face_api_secret =d9wuqgcylvocidsbx35uth******** @value("${face_api_key}") private string api_key; @value("${face_api_secret}") private string api_secret; @value("${face_api_key}") private string api_key; @value("${face_api_secret}") private string api_secret;所以一般常用的配置都是配置在application.properties文件的
以上所述是小编给大家介绍的spring boot 的常用注解使用小结,希望对大家有所帮助