Mybatis+SpringMVC商城项目注解总结

最新推荐文章于 2023-02-18 07:00:00 发布

Mars星空

最新推荐文章于 2023-02-18 07:00:00 发布

阅读量164

点赞数

文章标签： mybatis java 开发语言

本文链接：https://blog.csdn.net/weixin_50831410/article/details/128178421

版权

Mybatis+SpringMVC商城项目注解总结

lombok框架注解

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`注解的配置作为当前注解的参数