Spring框架的注解

@PostMapping("/getDetails")   post请求   映射到接口               @RequestBody    用来接收HTTP请求体中参数

@GetMapping("/getDetails")     get请求   映射到接口               @RequestParam   用来接收URL中的查询参数

@PutMapping

@DeleteMapping

@Api(tags = "部门****")   用于对整个控制器类进行说明，可通过tags属性来描述该控制器的功能，方便在Swagger文档中进行分类显示。

@RestController           这表示这是一个RESTful风格的Controller 会自动将返回的数据 转换为JSON格式  是Spring Framework 中用于标识 RESTful Web 服务的控制器（Controller）的注解之一

@RequestMapping(/system/**)  用于映射接口的根路径    例:http://127.0.0.1:8009/test/getDetails

@Resource                用于注入依赖实例

@ApiOperation            用于对接口方法 进行说明 可通过value属性来描述该方法的功能 方便在Swagger文档中进行分类显示。

@Tag(name = "部门****")  

@Operation(summary = "获取用户列表")  这俩个也是api文档注解

@PathVariable   是 Spring MVC 中用于从 URI 模板中提取变量值的注解。当你的请求路径 中包含占位符（例如 /users/{userId}），你可以使用 @PathVariable 注解 将占位符中的值映射到方法的参数上

@GetMapping("/users/{userId}")
public ResponseEntity<User> getUserById(@PathVariable Long userId) {// 方法体
}

@Validated     Spring Framework 中用于开启方法级别的参数验证的注解

@PostMapping("/createUser")
public ResponseEntity<String> createUser(@Validated @RequestBody User user) {
}

@Validated 注解用于开启方法级别的参数验证，而 @RequestBody 注解用于将请求体中的数据映射到 User 对象

在User类中的  @NotNull  @Email  @Size(min = 5, max = 10).....

对这些参数设置的限制信息进行校验

@Autowired   是 Spring Framework 中用于进行依赖注入的注解。它可以被用于字段、构 造函数、Setter 方法等地方，用于告诉 Spring 容器将相应类型的 Bean 注 入到被注解的元素中

@Log(title = "部门管理", businessType = BusinessType.UPDATE)

自定义的日志记录注解 用于记录系统中不同操作的日志信息

title 属性可能用于指定日志的标题或名称，用于区分不同类型操作的日志记录

businessType 属性可能表示业务类型或操作类型，用于记录操作的种类(delete,update...)

@Log(title = "部门管理", businessType = BusinessType.DELETE)

@RequiresPermissions 注解是 Apache Shiro 框架中用于进行权限控制的注解

@RequiresPermissions("user:create") 表示 createUser 方法需要用户具有 "user:create" 权限才能被执行。如果当前用户没有这个权限，将会抛出 UnauthorizedException 异常

    

@PreAuthorize 是 Spring Security 框架中用于进行方法级别的访问控制的注解之一

@ss.hasPermi('system:user:remove') 中的 @ss.hasPermi 可能是一个自定义的方法，用于检查用户是否有指定的权限

@Service    是 Spring Framework 中的注解之一，用于标识一个类作为服务层组件

Spring 框架将被注解的类纳入 Spring 容器的管理，从而可以在应用程序的其他部分（如控制器、其他服务类等）中通过依赖注入来使用该服务。

@Override     是 Java 中的注解，用于告诉编译器，被注解的方法是重写（覆盖）了父类 （或接口）中的方法 如果使用了 @Override 注解但实际上没有覆盖父类的方 法，编译器就会报错(在impl 接口实现层)

@Transactional   是 Spring Framework 中用于声明事务行为的注解。它可以应用于类级别或方法级别，表示被注解的方法或类将被包装在一个事务中

@Mapper     在 MyBatis 中，@Mapper 注解用于标识一个 Java 接口是 MyBatis 的映射  器。使用 @Mapper 注解告诉 MyBatis 扫描这个接口，并为它创建一个代 理对象，从而可以在代码中调用这些方法来执行数据库操作 主要用于 MyBatis 的映射器接口

@Repository  用于标识一个类是数据访问对象（DAO）。它通常与持久层的实现类一起使 用，用于将数据访问异常（例如 DataAccessException）转换为 Spring 的数据 访问异常体系。@Repository 注解还启用了 Spring 的异常转换机制，将数据 库操作中的异常转换为 Spring 的数据访问异常，使得上层调用者可以更容易 地处理异常 用于 Spring 的数据访问对象

mapper文件中 MyBatis 中用于配置 SQL 映射的注解

@Select    注解用于映射一个查询操作，可以标注在接口的方法上或者是 XML 映射文件 的 <select> 元素上。它指定了要执行的 SQL 查询语句

@Insert @Delete @Update .....  如上

@Results 和 @Result

注解一起使用，用于定义查询结果的映射关系。@Results 注解标注在接口的方法上或者是 XML 映射文件的 <resultMap> 元素上，表示一个结果集映射。而 @Result 注解则用于指定一个属性和数据库字段之间的映射关系

@One 和 @Many

注解用于处理一对一和一对多的关联关系。它们通常与 @Result 注解一起使用，以指定不同实体之间的映射关系

@Param     是 MyBatis 中用于指定传递给 SQL 查询的参数的注解。它主要用于将方法参 数与 SQL 查询中的参数进行映射

@Options   用于配置一些可选的属性，例如主键自动生成策略

@Insert("INSERT INTO users (username, password) VALUES (#{username}, #{password})")
@Options(useGeneratedKeys = true, keyProperty = "id")
void insertUser(User user);

@SelectKey：用于配置查询操作后获取生成的主键。

@Insert("INSERT INTO users (username, password) VALUES (#{username}, #{password})")
@SelectKey(statement = "SELECT LAST_INSERT_ID()", keyProperty = "id", before = false, resultType = Long.class)
void insertUserAndGetId(User user);

MyBatis 框架中的 XML 映射文件

sql.xml 文件

resultMap 标签

这段 XML 代码定义了一个名为 "SysUserResult" 的结果映射（resultMap），用于将数据库查询结果映射到 Java 对象 SysUser 中。

<resultMap type="SysUser" id="SysUserResult">: 这行代码表示正在创建一个结果映射，指定了它的类型是 SysUser，并且赋予了它一个 ID 名称为 "SysUserResult"，以便在后续的 SQL 映射中引用。

<id property="userId" column="user_id" />: 这个部分将数据库表中的 "user_id" 列映射到 SysUser 对象的 userId 属性。这个属性通常代表对象的主键。

<result property="deptId" column="dept_id" />: 类似地，将数据库中的 "dept_id" 列映射到 SysUser 对象的 deptId 属性。

<association property="dept" javaType="SysDept" resultMap="deptResult" />: 这是一个复杂类型的映射，它将 SysUser 对象中的 dept 属性映射到另一个复杂类型对象 SysDept。这意味着在查询 SysUser 对象时，可以将相关的 SysDept 对象作为属性关联起来。deptResult 是另一个 resultMap 的引用，用于映射 SysDept 对象的属性。

<collection property="roles" javaType="java.util.List" resultMap="RoleResult" />: 这个部分定义了一个集合属性 roles，它是 SysUser 对象的一个属性，表示一个用户可能有多个角色。这个集合的类型是 java.util.List，并且它的元素类型是 RoleResult resultMap 所定义的类型。这允许将查询到的多个角色映射为一个角色列表。

总的来说，这个 <resultMap> 定义了如何将数据库查询的列映射到 SysUser 对象及其关联对象（SysDept 和角色列表）的属性上，为 MyBatis 提供了一个详细的映射配置。

<sql>   标签通常用于存储可复用的 SQL 片段，以便在文件中的多个地方重用相同的 SQL 代码段。通过这种方式，可以提高代码的可读性、可维护性和重用性    id 属性指定了这个 SQL 片段的标识符为 "selectDeptVo"

<select> 元素是用来执行查询操作的，表示你希望从数据库中检索数据。

除此之外 还有 <update> <delete> ......

id="selectDeptById"：这是这个查询语句的唯一标识符。在 MyBatis 中，每个 SQL 查询语句都必须有一个唯一的标识符，以便在 Java 代码中引用它。

parameterType="Long"：这指定了查询语句的输入参数类型。在这种情况下，这个查询期望一个类型为 Long 的参数。这通常用于传递查询所需的条件，例如通过部门的ID来查询相关信息。

resultMap="SysDeptResult"：这指定了查询结果的映射规则。在 MyBatis 中，可以使用 <resultMap> 元素定义如何将数据库查询结果映射到 Java 对象。SysDeptResult 可能是一个预先定义的结果映射，规定了如何将数据库中的字段映射到 Java 对象的属性。

@ApiImplicitParams  是一个包含多个@ApiImplicitParam的容器

@ApiImplicitParam   用于具体描述每个参数 通过"name"指定名 "value"来描述参数的含 义  "require" 来标识参数是否必"dataType" 来指定参数的数据类型

@slf4j           进行日志统计

Lombok注解

@Data             它可以自动生成类的常用方法，如 toString()、equals()、hashCode()、 getter 和 setter 等方法。使用 @Data 注解可以简化代码，并避免手动 编写这些常用方法

Swagger注解

@ApiModel          用于描述数据模型的信息

@ApiModelProperty  用于描述模型的属性信息。在这里，我们将 e_id 字段注解为一个属性，并指定了它的名称为 "id"，描述为 "id"，并标记为必需属性（required = true）

MyBatis框架注解

@Select           用于执行搜索操作的SQL操作

@Update           用于执行更新操作的SQL操作

@Insert           用于执行插入操作的SQL操作

@Delete      用于执行删除操作的SQL操作

@SelectProvider   允许使用自定义的 SQL 提供者类来动态生成 SQL 查询语句

@UpdateProvider   允许使用自定义的 SQL 提供者类来动态生成 SQL 查询语句

@InsertProvider   允许使用自定义的 SQL 提供者类来动态生成 SQL 查询语句

@Options          提供了一些选项，例如设置主键自增等

例子:

 1.  @Select("SELECT * FROM company WHERE name = #{name}")List<Test> searchByExactName(@Param("name") String name);

 

2.  @Update("UPDATE company SET name = #{name}, age = #{age}, address = #{address}, salary = #{salary} WHERE id = #{id}")int update(Test test);

@Select:

用于标识一个方法是查询操作，该方法会执行一个 SQL 查询语句并返回结果。

@Select 注解中的 value 属性用于指定要执行的 SQL 查询语句。

#{name} 是一个参数占位符，表示查询语句中的一个参数，@Param("name") String name 表示方法的参数名为 name，并将方法中的 name 参数映射到 SQL 查询语句中的 #{name} 占位符上。

@Update:

用于标识一个方法是更新操作，该方法会执行一个 SQL 更新语句并返回更新影响的行数。

@Update 注解中的 value 属性用于指定要执行的 SQL 更新语句。

#{name}, #{age}, #{address}, #{salary}, #{id} 都是参数占位符，表示更新语句中的多个参数，这些参数分别对应了 Test 实体类中的字段，而在 update 方法的参数 Test test 中，这些字段会被映射到对应的参数占位符上。

1, @SpringBootApplication

包含@Configuration、@EnableAutoConfiguration、@ComponentScan通常用在主类上；

相关注解                         说明

@ComponentScan            用来自动扫描被这些注解标识的类，最终生成ioc容器里的 bean，默认扫描范围是@ComponentScan注解所在配置类包 及子包的类

@SpringBootConfiguration 与@Configuration作用相同，都是用来声明当前类是一个配 置类，这里表明是springboot主类使用的配置类

@EnableAutoConfiguration 是springboot实现自动化配置的核心注解，通过这个注解把 spring应用所需的bean注入容器中

1. @Component、@Service、@Controller、@Repository 都是将类注入到spring容器中，

@Component,@Service,@Controller,@Repository注解标注的类，这些类会被纳入进spring容器中管理。

注解           说明

@Repository 持久层（dao）注入spring容器

@Service 业务逻辑层（server）注入spring容器

@Controller 控制层（controller）注入spring容器

@Component 普通pojo注入spring容器

3.@ResponseBody可以作用在方法上或类上，表示该方法的返回结果直接写入 HTTP response body 中，而不会被解析为跳转路径，即不会经过视图解析器，返回什么数据即在页面输入什么数据。@ResponseBody的作用其实是将java对象转为json格式的数据。

4.@RestController

该注解是@Controller和@ResponseBody的结合体，一般用于类，作用等于在类上面添加了@ResponseBody和@Controller

5.@AutoWired、@Qualifier、@Resource

这3个注解都是基于注解方式进行自动装配，在容器里面将查找到的bean返回，一般@AutoWired用得最多，@Qualifier则需要配合@AutoWired使用，@Resource则是可以通过名字进行自动装配

5.1

5.2@Qualifier  当有一个接口的多个实现类时，只用@AutoWired会报错，因为它有多个接口的实现类，不知道你要找哪一个，这个时候就需要在注入bean的时候起个名字，然后用@Qualifier注解指定哪一个bean(按照名字注入与装配)

接口实现类1,bean注入并起名字

接口实现类2,bean注入并起名字

两个注解的配合使用实现bean的自动装配

5.3@Resource   该注解的使用相当于@AutoWired和@Qualifier配合使用的效果

Resource(name="sayHello")

private SayHello sayhello

6.@RequestMapping、@GetMapping、@PostMapping

注解 说明

@RequestMapping @RequestMapping（url），通过该注解就可以通过配置的url进行访问，方式可以是get或post请求，两种方式均可

@GetMapping @GetMapping（url） ，功能类似的，只是这个限定了只能是Get请求

@PostMapping @PostMapping（url），功能类似的，只是这个限定了只能是Post请求

1. @Value、@ConfigurationProperties、@PropertySource

注解 说明

@Value 用于获取bean的属性，一般用于读取配置文件的数据，作用在变量上

在yml配置文件设置数据变量  mag:dev-信息读取在类内部    @Value(${msg})  prvite String msg;

@ConfigurationProperties 用于注入Bean属性，然后再通过当前Bean获取注入值，作用在类上

在yml配置文件设置数据变量

 student:name:信息age:12

读取在类外部作用于整个类   

 @ConfigurationProperties(prefix="student")  public class Student{String name;String age;     //类的字段名必须和配置文件的字段名一致}      //!! 要有getter 和 setter 方法才能注入成功

@PropertySource 用于指定要读取的配置文件，可以和@Value或@ConfigurationProperties配合使用

//PropertySource不支持yml文件读取   

案例配置文件people.properties ==>     people.name = 灰太狼 people.sex =男  @PropertySource(value={ "classpath: people.properties " },encoding="utf-8")@ConfigurationProperties(prefix="people")

8.@Configuration、@Bean

@Configuration作用于类上面，表明这是一个配置类，@Bean产生一个Bean对象加入Spring IOC容器

//一般这两个注解同时配合使用

注解 说明

@Configuration 作用于类上表示这是一个配置类，可理解为用spring的时候xml里面的< beans>标签

@Bean 产生bean对象加入容器，作用于方法，可理解为用spring的时候xml里 面的标签

9.@RequestParam、@RequestBody、@PathVariable、@RequestHeader、@CookieValue

注解 说明

@RequestParam 获取查询参数。即url?name=这种形式     

@RequestParam主要用于接收url?后面的参数，get或post请求，只要后面的url? 有参数都可以获取到对应的参数

@RequestParam注解有几个比较重要的属性，required 表示是否必须，默认为 true， 必须。defaultValue 可设置请求参数的默认值。value 为接收url的参数名（相当于 key值）。

@PathVariable 获取路径参数。即url/{id}这种形式。get获取post请求均可

@RequestParam 获取请求体数据（body）,get没有请求体，，一般用于post获取参数  // 果要传多个参数过去只能将其封装成一个类，如果是出现了多个@RequestBody 注解访问的时候会报400错误

@RequestHeader 获取请求头的信息

例: public String requestBody03(@RequestHeader(name = 'Content-Type') String contentType){return  contentType;

}

@CookieValue 获取Cookie的信息例:

@GetMapping("/demo3")public void demo3(@RequestHeader(name = "myHeader") String myHeader,@CookieValue(name = "myCookie") String myCookie) {System.out.println("myHeader=" + myHeader);System.out.println("myCookie=" + myCookie);}