项目中常用注解
@NoOperateLog:非重点日志
@Nullable:参数可以为空
@Validated:不能为空
@FeignClient(value = "zhanjiang-data-center-server", path = WebAddressConstant.FACE_COLLECT_LOG_ADDRESS_ROOT, configuration = {ResultFeignDecoder.class})
feign里面调server: 要调哪里,value=微服务名,path=具体映射的接口地址
@EnableFeignClients(basePackages = {"cc.rehome.feign.service"})
独立的服务调feign:我要调哪里的feign ,放上哪里的的包名
@ApiOperation:用在请求的方法上,说明方法的用途、作用
value="说明方法的用途、作用"
notes="方法的备注说明"
@ApiImplicitParams:用在请求的方法上,表示一组参数说明
@ApiImplicitParam:用在@ApiImplicitParams注解中,指定一个请求参数的各个方面
name:参数名
value:参数的汉字说明、解释
required:参数是否必须传
paramType:参数放在哪个地方
· header --> 请求参数的获取:@RequestHeader
· query --> 请求参数的获取:@RequestParam
· path(用于restful接口)--> 请求参数的获取:@PathVariable
· body(不常用)
· form(不常用)
dataType:参数类型,默认String,其它值dataType="Integer"
defaultValue:参数的默认值
@ApiResponses:用在请求的方法上,表示一组响应
@ApiResponse:用在@ApiResponses中,一般用于表达一个错误的响应信息
code:数字,例如400
message:信息,例如"请求参数没填好"
response:抛出异常的类
@ApiModel:用于响应类上,表示一个返回响应数据的信息
(这种一般用在post创建的时候,使用@RequestBody这样的场景,
请求参数无法使用@ApiImplicitParam注解进行描述的时候)
@ApiModelProperty:用在属性上,描述响应类的属性
@RequestParam(value=”参数名”,required=”true/false”,defaultValue=””):获取请求的参数
value:参数名
required:是否包含该参数,默认为true,表示该请求路径中必须包含该参数,如果不包含就报错。
defaultValue:默认参数值,如果设置了该值,required=true将失效,自动为false,如果没有传该参数,就使用默认值
@Configuration
@ConfigurationProperties(prefix = "eam-config"):指向配置文件中属性