Spring注解学习

@RestController注解

这是一个组合注解，放在类上。该注解组合了@ResponseBody和@Controller，默认了类中所有的方法都包含ResponseBody注解的一种简写形式

@RequestMapping注解

该注解是映射请求地址，可放在类上或方法上。当放在一个类上时，代表父路径，调用这个类的方法时，必须在加上父路径才能进行访问。它有六个属性。

@RequestMapping(value = {"/modifyGet.do","/modifyGet1.do"}, method={RequestMethod.POST, RequestMethod.GET},consumes={"application/json"}, produces={"application/json"}, params={"name=mike","pwd=123456"},headers={"a=1"}) 

1.value和method
value值：设置请求路径
method值：设置请求的类型。如:RequestMethod.POST，RequestMethod.GET
2.consumes和produces
consumes:设置处理请求内容的提交形式。例如：application/json, text/html。application/json是序列化后的 JSON 字符串。
produces:设置处理请求后返回内容的形式。
3.params和headers
params： 指定request中必须包含某些参数值是，才让该方法处理。
headers： 指定request中必须包含某些指定的header值，才能让该方法处理请求。

@Valid注解

该注解用于校验。
1.首先在实体类的相应的属性前增加校验条件，有如下校验条件注解
@Null（message = “不能为空”）可使用其属性message.
限制只能为null

@NotNull
限制必须不为null

@AssertFalse
限制必须为false

@AssertTrue
限制必须为true

@DecimalMax(value)
限制必须为一个不大于指定值的数字

@DecimalMin(value)
限制必须为一个不小于指定值的数字

@Digits(integer,fraction)
限制必须为一个小数，且整数部分的位数不能超过integer，小数部分的位数不能超过fraction

@Future
限制必须是一个将来的日期

@Max(value)
限制必须为一个不大于指定值的数字

@Min(value)
限制必须为一个不小于指定值的数字

@Past
限制必须是一个过去的日期

@Pattern(value)
限制必须符合指定的正则表达式

@Size(max,min)
限制字符长度必须在min到max之间

@Past
验证注解的元素值（日期类型）比当前时间早

@NotEmpty
验证注解的元素值不为null且不为空（字符串长度不为0、集合大小不为0）

@NotBlank
验证注解的元素值不为空（不为null、去除首位空格后长度为0），不同于@NotEmpty，@NotBlank只应用于字符串且在比较时会去除字符串的空格

@Email
验证注解的元素值是Email，也可以通过正则表达式和flag指定自定义的email格式
2.在要校验的方法参数前增加@Valid

@Min(value = 18,message = "年龄不合法")
private Integer age;

//controller层增加@valid注解对需校验的方法参数进行校验
@PostMapping("/users")
public User addUser(@RequestBody @Valid User user, BindingResult bindingResult) {
    if(bindingResult.hasErrors()){
        System.out.println(bindingResult.getFieldError().getDefaultMessage());
        return null;
    }
    return userResposity.save(user);
}

@SpringBootApplication(SanBasePackages = {".com"})注解

此注解等价于@Configuration、@EableAutoConfiguration、@ComponentScan（此@ComponentScan注解是扫描类，识别注解，@ComponentScan默认会装配标识了@Controller，@Service，@Repository，@Component注解的类到spring容器中。）
这个注解有个属性SanBasePackages = {},注明扫描哪些包。

@MapperScan(basePackages)注解

此注解识别@mapper注解，mapper层类加上@mapper的注解

@Transactional(rollbackFor=Exception.class)注解

此注解只能应用到 public 可见度的方法或类上。 如果应用在protected、private或者 package可见度的方法上，也不会报错，不过事务设置不会起作用。对项目的方法或类中，发生异常时，事务进行回滚操作。其中rollbackFor=Exception.class属性,可以让事物在遇到非运行时异常时也回滚。否则只能在遇到运行时异常才能回滚。

@RefreshScope注解

此注解放置类上，作用热部署注解，可以不重新启动项目完成更新配置操作

@PostConstruct注解

该注解的说明：@PostConstruct该注解被用来修饰一个非静态的void（）方法。被@PostConstruct修饰的方法会在服务器加载Servlet的时候运行，并且只会被服务器执行一次。PostConstruct在构造函数之后执行，init（）方法之前执行。完成一个类的初始化操作

@Retryable注解（重试机制）

@Retryable注解
被注解的方法发生异常时会重试
value:指定发生的异常进行重试
include:和value一样，默认空，当exclude也为空时，所有异常都重试
exclude:指定异常不重试，默认空，当include也为空时，所有异常都重试
maxAttemps:重试次数，默认3
backoff:重试补偿机制，默认没有
此外启动类上，须加上启动重试机制的注解@EnableRetry

@Retention（元注解）

链接: 参考网址.

@Async注解

Spring为任务调度与异步方法执行提供了注解支持。通过在方法上设置@Async注解，可使得方法被异步调用。也就是说调用者会在调用时立即返回，而被调用方法的实际执行是交给Spring的TaskExecutor来完成。一般与定时任务配合使用。@Async注解的value属性是线程池对象。
如@Async（“scheduledAsyncPoolTaskExecutor”）,后面的value值是从Spring容器中取出对应的名字的线程池对象。
此外，启动类须加上@EnableAsync。

@Scheduled注解

定时任务注解，表示此方法按Cron表达式定时执行。
如@Scheduled（cron="${back.up.repay.record:0 0 4 ? * SUN}"）。表示优先从配置中取得cron表达式，若配置取值不成功，则按冒号后的表达式定时进行。
corn表达式符号依次表示：秒、分钟、小时、日期、月份、星期、年（可选），注意定时任务都是异步执行，试想谁也不可能主线程一直跑定时任务。
则实例中，表达式的含义为每个月每周的星期日的凌晨4点钟执行方法。

@Qualifer注解

作用同@Bean注解

@ConditionalOnExpression注解

此注解表示只能在属性为true的情况下，才能实例化Bean对象
实例：

@ConditionalOnExpression（“${phcsp.enable.ss.redis:false}”）  //默认从配置中取值，当取值失败则按false处理
@Bean

@autowired注解（required属性）

参考@autowired的四种模式

一、required属性，当值为false时，可以保证其当注入失败时。程序不会报错
二、autowired注解可对构造器的入参进行初始化

@Component
public class FieldSupportFactory {

    private final static Map<String,Object> strategyMap = new ConcurrentHashMap<>();

    @Autowired
    public FieldSupportFactory(List<String> paraList){
        /**
         * 清空map里面的内容，@Autowired对构造器的入参进行初始化
         */
        this.strategyMap.clear();
        for (String s : paraList) {
            strategyMap.put(s,s);
        }

    }

}

@configuration注解

1.@Configuration用于定义配置类，可替换xml配置文件
2.@Configuration启动容器+@Bean注册Bean。向Spring容器中注入对象

@AnnotationConfigApplicationContext注解

启动类

@ConditionalOnBean(name=“redisTemplate”)注解

表示当redisTemplate存在时，该注解的bean对象才能生成成功。

@requestbody和@requestparam注解

区别：入参为json数据格式（且包有多层内容）时，只能采用@requestbody注解

@Feignclient注解实现微服务项目之间的模块调用

@Component
@FeignClient(value = "service-a",fallback = ServiceA.class) //这里的name对应调用服务模块名,fallback属性为当调用失败时，返回的逻辑
public interface ServiceAFeignClient {
 		//对应的实际业务控制层的路径
    @RequestMapping(value = "/hi")
    String hi(@RequestParam("id") String id);
 
}

模块之间调用的熔断处理

@Component
public class FeignClientStudyImpl implements FeignClientStudy {

    @Override
    public String uplmodularCommonQuery(Map requestMap) {
        throw new Exception("熔断处理");
    }
}

Spring的打桩测试

@MockBean注解

使用此注解注入的类，表明类中的所有方法都使用自定义返回的值，这样在测试的时候就不会真的去调用远程接口，而是返回一个我们预设的值

@MockBean
protected AirTicketBuyDataServiceFeignClient buyDataServiceFeignClient;

@Test
public void addComsumptions() {
	String json = "{\"buyOrderExtendBo\":{\"keyId\":\"1910081525037263066XXXX182\",\"orderId\":\"191008152448182781\",\"sellOrderId\":\"191008152447001294\",\"bookOffice\":\"\",\"outTicketOffice\":\"\",\"outTicketAccount\":\"18683561923\",\"outTicketPayAccount\":\"\",\"itineraryDispatchTypeID\":0,\"itineraryDispatchTypeName\":\"无行程单\",\"itineraryExpressMoney\":0.00,\"recipientName\":\"\",\"postAddress\":\"\",\"recipientPhoneNum\":\"\",\"itineryCreateState\":0,\"itineryCreateStateDes\":\"不需要\",\"itineryFailReason\":\"\",\"itineryOrderId\":\"\",\"key1\":\"0\",\"key2\":\"\",\"key3\":\"\",\"key4\":\"\",\"key5\":\"\",\"key6\":0,\"key7\":0,\"key8\":\"2019-10-08 15:25:04\",\"key9\":\"2019-10-08 15:25:04\",\"key10\":\"2019-10-08 15:25:04\",\"addTime\":\"2019-10-08 15:25:04\",\"isDelete\":0,\"outPayType\":0,\"outPayAccount\":\"\",\"outPayTradeNo\":\"\",\"outPayBillNo\":\"\"},\"buyOrderInfoBo\":{\"keyID\":\"1910081525036229769XXXX182\",\"orderId\":\"191008152448182781\",\"sellOrderId\":\"191008152447001294\",\"tMCNo\":\"20160426135933567151\",\"tMCName\":\"小霞TMC0\",\"corpNo\":\"20160712160619032240\",\"corpName\":\"锦茵TMC\",\"serviceProviderID\":\"20180702000000000002\",\"serviceProviderName\":\"官网产品001\",\"supplyId\":\"20190730194131772844\",\"supplyName\":\"官网产品001\",\"orderType\":0,\"orderTypeName\":\"普通订单\",\"ticketType\":0,\"voyageType\":0,\"voyageTypeName\":\"单程\",\"voyageLeg\":\"银川-中卫\",\"voyageLegEn\":\"\",\"flightNos\":\"JR1509\",\"passengerCount\":1,\"passengers\":\"池鱼\",\"passengerType\":0,\"takeOffTime\":\"2019-10-23 08:00:00\",\"pNR\":\"\",\"bigPNR\":\"\",\"newPnr\":\"\",\"newBigPnr\":\"\",\"bookingSource\":2,\"bookingSourceName\":\"IOS\",\"orderDisplayID\":0,\"orderDisplayName\":\"创单失败\",\"orderChildDisplayID\":0,\"orderChildDisplayName\":\"\",\"orderFlag\":0,\"chanelId\":\"20\",\"chanelName\":\"QUNAR\",\"chanelOrderId\":\"D19297165242003581\",\"failReason\":\"占座失败\",\"ticketTotalMoney\":50.00,\"airraxTotalMoney\":0.00,\"oilraxTotalMoney\":0.00,\"insuranceTotalMoney\":0.00,\"itineraryTotalMoney\":0.00,\"taxTotalMoney\":0.00,\"payPoundage\":0.00,\"allPayMoney\":50.00,\"payType\":9,\"createOrderTime\":\"2019-10-08 15:24:48\",\"payTime\":\"2019-10-08 15:25:03\",\"outTicketTime\":\"2019-10-08 15:25:03\",\"cancelTicketTime\":\"2019-10-08 15:25:03\",\"linkMan\":\"池鱼\",\"linkPhone\":\"15198186997\",\"linkEmail\":\"\",\"operatorCorpNo\":\"20160712160619032240\",\"operatorCorpName\":\"锦茵TMC\",\"operatorDeptNo\":\"20160712160619032240\",\"operatorDeptName\":\"锦茵TMC\",\"operatorUserNo\":\"20190212174322616761\",\"operatorUserName\":\"池鱼\",\"importantLevel\":0,\"remark\":\"\",\"lockStatus\":0,\"lockStaffId\":\"\",\"lockStaffName\":\"\",\"lockTime\":\"2019-10-08 15:25:03\",\"addTime\":\"2019-10-24 20:08:16\",\"isDelete\":0,\"bankOrderId\":\"\",\"serviceFee\":0.00},\"buyTicketInfoBoList\":[{\"keyID\":\"1910081525036311800XXXX182\",\"orderId\":\"191008152448182781\",\"ticketNo\":\"\",\"userName\":\"池鱼\",\"userEnglishName\":\"\",\"passengerIndex\":0,\"passengerType\":0,\"passengerTypeName\":\"\",\"passengerGender\":1,\"identity\":0,\"cardType\":0,\"cardTypeName\":\"身份证\",\"cardNo\":\"510902199601127713\",\"birthDay\":\"1996-01-12\",\"international\":\"\",\"passengerPhoneNum\":\"15198186997\",\"voyageLeg\":\"银川-中卫\",\"voyageLegEn\":\"\",\"salesPrice\":50.00,\"oilrax\":0.00,\"airrax\":0.00,\"needItinerary\":0,\"itineraryMoney\":0.00,\"needInsurance\":0,\"insuranceMoney\":0.00,\"isNeedInsInvoice\":0,\"totalMoney\":50.00,\"ticketPrice\":50.00,\"tax\":0.00,\"cardValidityTime\":\"2019-10-08 15:24:30\",\"refundFlag\":0,\"isRefundFlag\":0,\"isRefundFlagName\":\"\",\"refundChangeModifyTime\":\"2019-10-08 15:25:04\",\"civilServantValidType\":0,\"cardBankID\":0,\"cardBankName\":\"\",\"budgetUnitName\":\"\",\"issueCountry\":\"\",\"addTime\":\"2019-10-08 15:25:04\",\"isDelete\":0}],\"buyVoyageInfoBoList\":[{\"keyID\":\"1910081525036386708XXXX182\",\"orderId\":\"191008152448182781\",\"sequence\":0,\"carrier\":\"JR\",\"carrierName\":\"幸福\",\"flightNo\":\"JR1509\",\"cabin\":\"G\",\"cabinName\":\"经济舱\",\"cabinType\":0,\"planType\":\"小\",\"deptCity\":\"INC\",\"arrCity\":\"ZHY\",\"deptCityCh\":\"银川\",\"arrCityCh\":\"中卫\",\"deptAirport\":\"INC\",\"arrAirport\":\"ZHY\",\"deptAirportCh\":\"河东\",\"arrAirportCh\":\"香山机场\",\"deptTime\":\"2019-10-23 08:00:00\",\"arrTime\":\"2019-10-23 08:45:00\",\"orgJetquay\":\"T3\",\"dstJetquay\":\"\",\"discount\":\"9\",\"stopOver\":0,\"stopOverCity\":\"\",\"stopOverCityCh\":\"\",\"sOAirport\":\"\",\"sOAirportCh\":\"\",\"midTakeOffTime\":\"1900-01-01 00:00:00\",\"midArrTime\":\"1900-01-01 00:00:00\",\"isTransfer\":0,\"transferOrgSequence\":0,\"isShare\":0,\"reallyFlightNo\":\"\",\"policyId\":\"CL||\",\"returnPoint\":\"0\",\"isSelfCarrierTicket\":0,\"largeCustomerNum\":\"\",\"isStandardRule\":1,\"unStandardRule\":\"{\\\"isAllowedToSign\\\":1,\\\"changeTicketRuleInfo\\\":\\\"S:2019-10-16 08:00前|¥10\\\\/人^2019-10-21 08:00前|¥15\\\\/人^2019-10-23 04:00前|¥25\\\\/人^2019-10-23 08:00|¥35\\\\/人\\\",\\\"refundTicketRuleInfo\\\":\\\"S:2019-10-16 08:00前|¥15\\\\/人^2019-10-21 08:00前|¥25\\\\/人^2019-10-23 04:00前|¥45\\\\/人^2019-10-23 04:00后|¥50\\\\/人\\\",\\\"remark\\\":\\\"1.随身携带1件行李，重量不超5KG，体积不超20*30*40CM；2.免费手动行李：20KG。\\\"}\",\"policyPlattype\":1,\"priceSource\":\"0\",\"policySign\":7,\"baggageCount\":0.00,\"baggageWeight\":0.00,\"isNightFlight\":0,\"flightType\":1,\"planModel\":\"\",\"flyTime\":\"\",\"subProductId\":\"\",\"policyExInfo\":\"{\\\"airAgentDiscount\\\":\\\"9\\\",\\\"oriClassDiscount\\\":\\\"0\\\",\\\"publicHighPrice\\\":\\\"0\\\",\\\"publicLowPrice\\\":\\\"0\\\",\\\"salePrice\\\":\\\"0\\\",\\\"calculateDiscount\\\":\\\"0\\\",\\\"prefMoney\\\":\\\"0\\\",\\\"ch_segId\\\":\\\"0\\\"}\",\"remark\":\"\",\"addTime\":\"2019-10-08 15:25:04\",\"isDelete\":0}]}\n";
	TicketBuyOrderInfoVo orderInfoVo = GsonUtil.gson.fromJson(json, TicketBuyOrderInfoVo.class);
	
	when(buyDataServiceFeignClient.getBuyOrderInfoVoByOrderId(anyString())).thenReturn(orderInfoVo);
}

@SpyBean注解

使用此注解注入的类，表明类中的某一个方法使用使用自定义返回的值，在测试时，如果使用到了多个方法，那么只是遵循@SpyBean写法的方法会返回我们自定义的值，在使用时在使用方法上和@MockBean类似，不过写法有所区别

@SpyBean
protected IAutoTicketDao autoTicketDao;

@Test
public void addComsumptions_Out() {
    String json1 = "{\"orderID\":\"190801084547167995\",\"sellerDeptID\":\"340559\",\"orderStatus\":8,\"outTicketTime\":\"2019-08-01 08:54:33\",\"payCompanyOrderID\":\"FX2019080143357941\",\"outTradeNo\":\"NT19080100004112\",\"airCode\":\"ZH\",\"seatClass\":\"E\",\"takeOffTime\":\"2019-08-08 21:35:00\",\"fromCity\":\"CKG\",\"toCity\":\"SZX\",\"inStockStaff\":\"SZX49802\",\"ticketOutInterface\":10,\"airPayAccount\":\"SZCYSD517\",\"inStockTime\":\"2019-08-01 08:54:33\",\"bigCustomerID\":\"\",\"buyerDeptName\":\"云南昆明盛世航空\",\"flightNO\":\"9428\",\"bigPNR\":\"PCYL5W\",\"orderPnr\":\"HM6XMK\"}";
    AutoOrder autoOrder = GsonUtil.gson.fromJson(json1, AutoOrder.class);
    
    doReturn(autoOrder).when(autoTicketDao).getAutoOrderByOrderId(anyString(), anyObject());

}

Spring打桩参考文章

@Transactional注解

此注解放在方法上，方法必须为public级别，最好将增删改数据的操作放在此方法上。当程序执行错误时，会将脏数据回滚。
但此注解会消耗程序方法的执行效率

@Transactional
public void demo() {
    this.userRepository.save(new User(USERNAME));
}

@ModelAttribute注解

此注解修饰参数，用于接受前端提交的表单请求。可将表单的请求参数映射成一个对象

@RequestMapping("/updateUser")
public String testModelAttribute(@ModelAttribute User user) { 
    System.out.println("控制器中处理请求的方法：修改用户："+user);
     return "success";