Mybatis+SpringMVC商城项目注解总结-创新互联

Mybatis+SpringMVC商城项目注解总结
  • lombok框架注解

    成都创新互联公司自2013年创立以来,是专业互联网技术服务公司,拥有项目成都网站建设、网站制作网站策划,项目实施与项目整合能力。我们以让每一个梦想脱颖而出为使命,1280元南安做网站,已为上家服务,为南安各地企业和个人服务,联系电话:13518219792

    Lombok框架是用于在编译期自动生成相关代码的,例如:Setters & Getters、hashCode()equals()toString()、无参数构造方法、全参数构造方法等。

import lombok
@Slf4j 完成日志打印 在类上使用	
    log.trace("")
    log.info("")
    log.debug("")
    log.warn("")
    log.error("")
    
@Setter: 添加在属性上,用于生成此属性的Setter方法,或者,添加在类上,用于生成此类中所有属性的Setter方法
    
@Getter: 添加在属性上,用于生成此属性的Getter方法,或者,添加在类上,用于生成此类中所有属性的Getter方法
    
@ToString: 添加在类上,用于生成基于此类中所有属性的`toString()`方法

@EqualsAndHashCode: 添加在类上,用于生成基于此类中所有属性的`hashCode()`和`equals()`方法,生成的方法将保证:如果2个对象的类型相同,且所有属性值相同,则`hashCode()`返回相同的结果,且`equals()`对比结果为`true`,否则,`hashCode()`返回不同的结果,且`equals()`对比结果为`false`
    
@NoArgConstructor: 添加在类上,用于生成无参数构造方法

@AllArgConstructor: 添加在类上,用于生成基于此类中所有属性的全参数构造方法

@Data 添加在类上,用于生成Setters & Getters、`hashCode()`、`equals()`、`toString()`,使用此注解时,必须保证当前类的父类存在无参数构造方法
  • SpringWeb框架提供的注解
import org.springframework.web.bind.annotation
@RequestMapping("请求url")
 @RequestMapping(value = "/add-new",method = RequestMethod.POST/GET)
@PostMapping("Post请求ur")
@GetMapping("Get请求ur")
    
@Controller 负责接收控制请求 有这个注解才能让SpringBoot框架运行时进入此类
    
@ResponseBody 注解的作用是将 controller 的方法返回的对象通过适当的转换器转换为指定的格式之后,写入到 response对象的 body 区,通常用来返回 JSON 数据或者是 XML 数据。
(注意: @ResponseBody一般在异步获取数据时使用【也就是AJAX】,在使用 @RequestMapping后,返回值通常解析为跳转路径,但是加上 @ResponseBody 后返回结果不会被解析为跳转路径,而是直接写入 HTTP response body 中。)

@RestController 此注解为@Controller+@ResponseBody
    
@RequestBody 用于将请求体中的数据绑定到方法的形参中,该注解用在方法的形参上。
(注意: @RequestBody 注解用于读取Request请求的body部分数据,使用系统默认配置的HttpMessageConverter进行解析,然后把相应的数据绑定到要返回的对象上;再把HttpMessageConverter返回的对象数据绑定到 controller中方法的参数上。)
  • 配置API文档注解
@Api:添加在控制器类上
    此注解的`tags`属性,可配置模块名称,可以在模块名称中使用编号,例如:`01. 品牌管理模块`,最终将按照编号升序排列

@ApiOperation:添加在控制器类中处理请求的方法上
    此注解的`value`属性,可配置业务名称

@ApiOperationSupport:添加在控制器类中处理请求的方法上
	此注解的`order`属性(`int`类型),可配置业务的排序序号,最终将升序排列

@ApiModelProperty:添加在POJO类型的属性上

  此注解的`value`属性,可配置参数名称(说明)
  此注解的`required`属性,可配置是否必须提交此参数
  此注解的`example`属性,可配置此请求参数的示例值

@ApiImplicitParam:添加在控制器类中处理请求的方法上,用于对未封装的请求参数添加说明(例如`Long id`参数)

  必须配置此注解的 name 属性,取值为方法的参数名称,表示当前注解对哪个参数进行说明
  此注解的 value 属性,可配置参数名称(说明)
  此注解的 required 属性,可配置是否必须提交此参数
  此注解的 dataType 属性,可配置参数的数据类型(例如取值为 "long" )
  此注解的 example 属性,可配置此请求参数的示例值

@ApiImplicitParams:添加在控制器类中处理请求的方法上,此注解的`value`属性是`@ApiImplicitParam`注解的数组类型,当需要使用@ApiImplicitParam:对多个未封装参数进行说明时,需要将多个`@ApiImplicitParam`注解的配置作为当前注解的参数
  • Validation框架注解

@Valid@Validated注解,用于表示此参数是需要通过Validation框架进行检查的!

(二者的不同点在于@Valid注解只能添加在参数前,@Validated还可以添加在类上用于监控方法中单个参数的值)

使用Validation框架检查数据格式时,常用的检查注解有:

  • @NotNull:不允许为null
    • 可用于任何类型的参数
  • @NotEmpty:不允许为空字符串,即长度为0的字符串
    • 仅用于检查字符串类型的参数
  • @NotBlank:不允许为空白的字符串,即仅由空格或TAB制表位或换行组成的值
    • 仅用于检查字符串类型的参数
  • @Length:限制字符串的长度
  • @Pattern:通过正则表达式检查字符串的格式,此注解的regexp属性就是定义正则表达式的属性
    • 仅用于检查字符串类型的参数
  • @Min:限制整型数值的最小值
    • 仅用于检查整型数值参数
  • @Max:限制整型数值的大值
    • 仅用于检查整型数值参数
  • @Range:限制整型数值的取值区间,默认最小值为0,大值为long的上限值
    • 仅用于检查整型数值参数

所有检查注解都有message属性,用于配置检查失败时的提示文本。

每个被检查参数可以同时添加多个检查注解!

注意:@NotNull注解可以添加在任何类型的参数上,并且,除了@NotNull以外的所有注解在参数为null时都会是检查通过的结果,所以,许多检查规则都会同时使用@NotNull和另一个检查注解(除非你允许这个参数是null)。

**提示:**在源代码中,找到某个检查注解的import语句,按住Ctrl键点击其包名,即可看到此包下还有哪些检查注解!

你是否还在寻找稳定的海外服务器提供商?创新互联www.cdcxhl.cn海外机房具备T级流量清洗系统配攻击溯源,准确流量调度确保服务器高可用性,企业级服务器适合批量采购,新人活动首月15元起,快前往官网查看详情吧


当前标题:Mybatis+SpringMVC商城项目注解总结-创新互联
浏览地址:http://abwzjs.com/article/cdsdop.html