Anotaciones comunes de MyBatis-Plus
Etiquetas relacionadas: 1.MyBatis con una experiencia más fluida
2. Potente: MyBatis y tres métodos de consulta en streaming
Anotaciones comunes de MyBatis-Plus
En aquellos años, las anotaciones comunes de MyBatis-Plus que hemos aprendido juntos
I. Introducción a las anotaciones comunes de MyBatis-Plus
Recientemente aprendí MyBatis-Plus y ahora le invito a repasar qué anotaciones usamos con frecuencia durante el proceso de aprendizaje. ¿Qué funciones tienen estas anotaciones? ¿Cómo se usan? Contenido especialmente útil para principiantes y para el repaso de los más experimentados~
¡Comencemos sin más!
2. Introducción a MyBatis-Plus
MyBatis-Plus (MP, por sus siglas) es una herramienta de mejora para MyBatis. Solo mejora y no modifica la base de MyBatis. Nació para simplificar el desarrollo y mejorar la eficiencia.
¡Su visión es ser el mejor aliado de MyBatis!
Sitio oficial: https://baomidou.com/
Dirección de publicación del documento: https://baomidou.com/pages/24112f
3. Anotaciones comunes de MyBatis. Anotaciones de uso frecuente
1. @MapperScan
@SpringBootApplication _
@MapperScan ( " com.cabbage.mapper " )
public class Mybatisplus01Application {
public static void main( String[] args ) {
SpringApplication.run ( Mybatisplus01Application.class, args );
}
}
Al combinar el código y las imágenes se puede deducir lo siguiente: la anotación @MapperScan sirve para escanear el archivo de mapeo de Mapper, y solo después de usarla podemos emplear los distintos métodos que ofrece la versión oficial.
2. @Mapper
@Mapper
@Repository
public interface UserMapper extends BaseMapper {
/**
* Consulta que devuelve una colección Map por id
* @param id
* @return
*/
Map< String,Object > selectMapById (Long id);
}
¿Por qué presento esta anotación por segunda vez? Porque @Mapper actúa sobre la clase de entidad de la base de datos, por lo que no es necesario volver a escribir la anotación @MapperScan. La diferencia entre ambas es que @Mapper solo puede mapear una clase de entidad, mientras que @MapperScan puede mapear las clases de entidad de todo el paquete. Su alcance es mayor y resulta más fácil de usar.
3. @TableName
Primero observe el siguiente código:
@Data
//Establece el nombre de la tabla que corresponde a la clase de entidad
@TableName("t_user")
public class User {
@TableId(value = "id",type = IdType.AUTO)
private Long uid;
@TableField(value = "name")
private String name;
private Integer age;
private String email;
@TableField(value = "is_deleted")
@TableLogic
private Integer isDeleted ;
}

Como es sabido, cuando el nombre de la clase de entidad no coincide con el nombre de la tabla que se va a operar, se genera un error; la anotación @TableName ayuda a resolver este problema. Si el nombre de la tabla en mi base de datos es t_user y el nombre de la clase de entidad es User, basta con escribir @TableName("t_user") sobre el nombre de la clase.
4. @Data
Esta anotación también simplifica enormemente el desarrollo. ¿Por qué lo digo? Porque con ella puede omitir getter(), setter() y toString(), además de sobrescribir los métodos equals() y hashCode() de la clase. ¿No le parece sorprendente?
5. @TableId
MyBatis-Plus implementa la inserción, la eliminación, la modificación y la consulta; usa id como columna de clave primaria por defecto y, al insertar datos, la estrategia
predeterminada basada en el algoritmo snowflake genera el id. El algoritmo snowflake no se explica aquí.
Cuando se usa la sentencia @TableId(value = "id"), si la clave primaria de la clase de entidad y de la tabla no es id sino otro campo, como uid en el código, MyBatis-Plus identificará automáticamente uid como la columna de clave primaria; de lo contrario, mostrará este error:
Cuando se usa la sentencia @TableId(value = "id", type = IdType.AUTO), se indica que se emplea la estrategia de autoincremento de la base de datos. Tenga en cuenta que, para este tipo, debe asegurarse de que la base de datos tenga el id con autoincremento; ¡de lo contrario, no tendrá efecto!
Por supuesto, la función de @TableId también puede escribirse en el archivo de configuración application.yml, de la siguiente manera:
mybatis -plus:
global-config:
banner: false
db -config:
# Configura el prefijo por defecto de la tabla que opera MyBatis-Plus
table-prefix: "t_"
# Configura la estrategia de clave primaria de MyBatis-Plus
id-type: auto
# Configura los logs de MyBatis
configuration:
log - impl : org.apache.ibatis.logging.stdout.StdOutImpl
6. @TableField
Cuando MyBatis-Plus ejecuta la sentencia SQL, debe asegurarse de que el nombre del atributo en la clase de entidad sea igual al nombre del campo en la tabla; de lo contrario, se generará un error. La sentencia @TableField(value = "is_deleted") indica que el campo is_deleted de la tabla de la base de datos corresponde al atributo isDeleted de la clase de entidad; así, ambos nombres de campo se consideran equivalentes.
Aviso:
Si los atributos de la clase de entidad usan el estilo de nomenclatura camel case y los campos de la tabla usan el estilo de nomenclatura con guion bajo,
por ejemplo, el atributo userName de la clase de entidad y el campo user_name de la tabla, MyBatis-Plus convertirá automáticamente el estilo de nomenclatura con guion bajo al estilo camel case.
Si los atributos de la clase de entidad y los campos de la tabla no cumplen las condiciones anteriores, como el atributo name de la clase de entidad y el campo username de la tabla, debe usar @TableField("username") sobre el atributo de la clase de entidad para establecer el nombre del campo que corresponde a ese atributo.
7. @TableLogic
Antes de hablar de esta anotación, entendamos primero la eliminación lógica.
Eliminación física: eliminación real; se eliminan los datos correspondientes de la base de datos y, por lo tanto, los datos eliminados ya no se pueden consultar
Eliminación lógica: eliminación simulada; se cambia a «estado eliminado» el estado del campo de datos que indica si el registro está eliminado y, por lo tanto, el registro de datos todavía se puede ver en la base de datos
Escenario de uso: permite la recuperación de datos
En mi tabla de la base de datos, cuando is_delete vale 1 significa eliminación lógica, y cuando is_delete vale 0 significa que no está eliminado
La anotación @TableLogic indica que las propiedades de la clase son propiedades con eliminación lógica
Aviso:
Al probar la eliminación lógica, lo que realmente se ejecuta es la modificación UPDATE t_user SET is_deleted =1 WHERE id=? AND is_deleted =0
Al probar la función de consulta, los datos con eliminación lógica no se consultan por defecto SELECT id,username AS name,age,email,is_deleted FROM t_user WHERE is_deleted =0
Para usar el complemento de paginación de MyBatis-Plus es necesario configurar el interceptor; vea el código:
@Configuration
public class MybatisPlusConfig {
@Bean
public MybatisPlusInterceptor mybatisPlusInterceptor ( ) {
MybatisPlusInterceptor interceptor =
new MybatisPlusInterceptor ( );
interceptor.addInnerInterceptor
(new PaginationInnerInterceptor ( DbType.MYSQL ));
return interceptor;
}
}
8. @Configuration
Seguramente ya vio esta anotación muchas veces y tal vez se esté impacientando, pero aun así quiero mencionarla aquí: la clase que usa esta anotación representa una clase de configuración y la clase en sí también es un bean. En esta clase también puede cargar beans mediante la anotación @Bean
9. @Bean
La anotación @Bean indica que el objeto del método se inyecta en el contenedor de Spring, y resulta cómodo extraer después el objeto del contenedor para simplificar el desarrollo. Suele usarse junto con la anotación @Configuration. Seguramente esta anotación le resulta familiar, así que no me extenderé más aquí~
Ahora que ya hablamos de los complementos de paginación, veamos su uso básico.
@Test
void test01() {
//Establece los parámetros de paginación
Page page = new Page< >( 1, 3);
userMapper.selectPage (page, null);
//Obtiene los datos de la paginación
List list = page.getRecords ();
list.forEach ( System.out :: println );
System.out.println ("Current page:" + page.getCurrent ());
System.out.println ("Number of items displayed per page: " + page.getSize ());
System.out.println ("Total records:" + page.getTotal ());
System.out.println ("Total pages: " + page.getPages ());
System.out.println ("Is there a previous page:" + page.hasPrevious ());
System.out.println ("Whether there is a next page: " + page.hasNext ());
}
Resultado de la operación:
10. @Param
Cuando uso una sentencia de paginación personalizada:
@Mapper
@Repository
public interface UserMapper extends BaseMapper {
/**
* Consulta la información de usuarios por edad y realiza la paginación
* @param page
* @param age
* @return
*/
Page selectPageByAge ( Page page, @Param("age") Integer age);
}
@Param es proporcionada por MyBatis. Como anotación de la capa Dao, sirve para pasar parámetros de modo que correspondan con el nombre del campo en SQL, lo que simplifica el desarrollo~
11. @Version
Al estudiar el bloqueo optimista, seguramente ha visto el siguiente código:
@Data
@TableName("t_product")
public class Product {
private Long id;
private String name;
private Integer price;
@Version
private Integer version;
}
@Configuration
public class MybatisPlusConfig {
@Bean
public MybatisPlusInterceptor mybatisPlusInterceptor() {
MybatisPlusInterceptor interceptor =
new MybatisPlusInterceptor ( );
//Complemento de paginación
interceptor.addInnerInterceptor
(new PaginationInnerInterceptor ( DbType.MYSQL ));
//Complemento de bloqueo optimista
interceptor.addInnerInterceptor (new OptimisticLockerInnerInterceptor ());
return interceptor;
}
}
Y esta anotación @Version es una anotación importante para implementar el bloqueo optimista. Cuando se van a actualizar los datos de la base de datos, como el precio, la versión se incrementa en 1. Si la versión en la sentencia where no es correcta, la actualización fallará.
Anotaciones comunes de MyBatis. @EnumValue
@Getter
public enum SexEnum {
MALE(1, "男"),
FEMALE(2, "女");
@EnumValue
private Integer sex;
private String sexName;
SexEnum(Integer sex, String sexName) {
this.sex = sex;
this.sexName = sexName;
}
}
mybatis -plus:
global-config:
banner: false
db -config:
# Configura el prefijo por defecto de la tabla que opera MyBatis-Plus
table-prefix: "t_"
# Configura la estrategia de clave primaria de MyBatis-Plus
id-type: auto
# Configura los logs de MyBatis
configuration:
log - impl : org.apache.ibatis.logging.stdout.StdOutImpl
# Configura el paquete que corresponde al alias de tipo
type-aliases-package: cabbage.pojo
# Configura el escaneo de enumeraciones
type- enums - package: cabbage.pojo
El valor del atributo identificado por la anotación @EnumValue se almacenará en la base de datos, lo que equivale a la sentencia INSERT INTO t_user ( username, age, sex ) VALUES ( ?, ?, ? )
Parámetros: Enum ( String), 20(Integer), 1(Integer)
Bueno, amigos, con esto prácticamente quedan explicadas las anotaciones comunes de MyBatis-Plus. Creo que ya ha sentido el cómodo respaldo de este marco de trabajo nacional (de origen chino). Espero que lo apoye activamente. Si considera que la redacción del autor no está mal, puede darle al autor el triple apoyo consecutivo ~~
2. Potente: MyBatis y tres métodos de consulta en streaming
Anotaciones comunes de MyBatis-Plus
En aquellos años, las anotaciones comunes de MyBatis-Plus que hemos aprendido juntos
I. Introducción a las anotaciones comunes de MyBatis-Plus
Recientemente aprendí MyBatis-Plus y ahora le invito a repasar qué anotaciones usamos con frecuencia durante el proceso de aprendizaje. ¿Qué funciones tienen estas anotaciones? ¿Cómo se usan? Contenido especialmente útil para principiantes y para el repaso de los más experimentados~
¡Comencemos sin más!
2. Introducción a MyBatis-Plus
MyBatis-Plus (MP, por sus siglas) es una herramienta de mejora para MyBatis. Solo mejora y no modifica la base de MyBatis. Nació para simplificar el desarrollo y mejorar la eficiencia.
¡Su visión es ser el mejor aliado de MyBatis!
Sitio oficial: https://baomidou.com/
Dirección de publicación del documento: https://baomidou.com/pages/24112f
3. Anotaciones comunes de MyBatis. Anotaciones de uso frecuente
1. @MapperScan
@SpringBootApplication _
@MapperScan ( " com.cabbage.mapper " )
public class Mybatisplus01Application {
public static void main( String[] args ) {
SpringApplication.run ( Mybatisplus01Application.class, args );
}
}
Al combinar el código y las imágenes se puede deducir lo siguiente: la anotación @MapperScan sirve para escanear el archivo de mapeo de Mapper, y solo después de usarla podemos emplear los distintos métodos que ofrece la versión oficial.
2. @Mapper
@Mapper
@Repository
public interface UserMapper extends BaseMapper
/**
* Consulta que devuelve una colección Map por id
* @param id
* @return
*/
Map< String,Object > selectMapById (Long id);
}
¿Por qué presento esta anotación por segunda vez? Porque @Mapper actúa sobre la clase de entidad de la base de datos, por lo que no es necesario volver a escribir la anotación @MapperScan. La diferencia entre ambas es que @Mapper solo puede mapear una clase de entidad, mientras que @MapperScan puede mapear las clases de entidad de todo el paquete. Su alcance es mayor y resulta más fácil de usar.
3. @TableName
Primero observe el siguiente código:
@Data
//Establece el nombre de la tabla que corresponde a la clase de entidad
@TableName("t_user")
public class User {
@TableId(value = "id",type = IdType.AUTO)
private Long uid;
@TableField(value = "name")
private String name;
private Integer age;
private String email;
@TableField(value = "is_deleted")
@TableLogic
private Integer isDeleted ;
}

Como es sabido, cuando el nombre de la clase de entidad no coincide con el nombre de la tabla que se va a operar, se genera un error; la anotación @TableName ayuda a resolver este problema. Si el nombre de la tabla en mi base de datos es t_user y el nombre de la clase de entidad es User, basta con escribir @TableName("t_user") sobre el nombre de la clase.
4. @Data
Esta anotación también simplifica enormemente el desarrollo. ¿Por qué lo digo? Porque con ella puede omitir getter(), setter() y toString(), además de sobrescribir los métodos equals() y hashCode() de la clase. ¿No le parece sorprendente?
5. @TableId
MyBatis-Plus implementa la inserción, la eliminación, la modificación y la consulta; usa id como columna de clave primaria por defecto y, al insertar datos, la estrategia
predeterminada basada en el algoritmo snowflake genera el id. El algoritmo snowflake no se explica aquí.
Cuando se usa la sentencia @TableId(value = "id"), si la clave primaria de la clase de entidad y de la tabla no es id sino otro campo, como uid en el código, MyBatis-Plus identificará automáticamente uid como la columna de clave primaria; de lo contrario, mostrará este error:
Cuando se usa la sentencia @TableId(value = "id", type = IdType.AUTO), se indica que se emplea la estrategia de autoincremento de la base de datos. Tenga en cuenta que, para este tipo, debe asegurarse de que la base de datos tenga el id con autoincremento; ¡de lo contrario, no tendrá efecto!
Por supuesto, la función de @TableId también puede escribirse en el archivo de configuración application.yml, de la siguiente manera:
mybatis -plus:
global-config:
banner: false
db -config:
# Configura el prefijo por defecto de la tabla que opera MyBatis-Plus
table-prefix: "t_"
# Configura la estrategia de clave primaria de MyBatis-Plus
id-type: auto
# Configura los logs de MyBatis
configuration:
log - impl : org.apache.ibatis.logging.stdout.StdOutImpl
6. @TableField
Cuando MyBatis-Plus ejecuta la sentencia SQL, debe asegurarse de que el nombre del atributo en la clase de entidad sea igual al nombre del campo en la tabla; de lo contrario, se generará un error. La sentencia @TableField(value = "is_deleted") indica que el campo is_deleted de la tabla de la base de datos corresponde al atributo isDeleted de la clase de entidad; así, ambos nombres de campo se consideran equivalentes.
Aviso:
Si los atributos de la clase de entidad usan el estilo de nomenclatura camel case y los campos de la tabla usan el estilo de nomenclatura con guion bajo,
por ejemplo, el atributo userName de la clase de entidad y el campo user_name de la tabla, MyBatis-Plus convertirá automáticamente el estilo de nomenclatura con guion bajo al estilo camel case.
Si los atributos de la clase de entidad y los campos de la tabla no cumplen las condiciones anteriores, como el atributo name de la clase de entidad y el campo username de la tabla, debe usar @TableField("username") sobre el atributo de la clase de entidad para establecer el nombre del campo que corresponde a ese atributo.
7. @TableLogic
Antes de hablar de esta anotación, entendamos primero la eliminación lógica.
Eliminación física: eliminación real; se eliminan los datos correspondientes de la base de datos y, por lo tanto, los datos eliminados ya no se pueden consultar
Eliminación lógica: eliminación simulada; se cambia a «estado eliminado» el estado del campo de datos que indica si el registro está eliminado y, por lo tanto, el registro de datos todavía se puede ver en la base de datos
Escenario de uso: permite la recuperación de datos
En mi tabla de la base de datos, cuando is_delete vale 1 significa eliminación lógica, y cuando is_delete vale 0 significa que no está eliminado
La anotación @TableLogic indica que las propiedades de la clase son propiedades con eliminación lógica
Aviso:
Al probar la eliminación lógica, lo que realmente se ejecuta es la modificación UPDATE t_user SET is_deleted =1 WHERE id=? AND is_deleted =0
Al probar la función de consulta, los datos con eliminación lógica no se consultan por defecto SELECT id,username AS name,age,email,is_deleted FROM t_user WHERE is_deleted =0
Para usar el complemento de paginación de MyBatis-Plus es necesario configurar el interceptor; vea el código:
@Configuration
public class MybatisPlusConfig {
@Bean
public MybatisPlusInterceptor mybatisPlusInterceptor ( ) {
MybatisPlusInterceptor interceptor =
new MybatisPlusInterceptor ( );
interceptor.addInnerInterceptor
(new PaginationInnerInterceptor ( DbType.MYSQL ));
return interceptor;
}
}
8. @Configuration
Seguramente ya vio esta anotación muchas veces y tal vez se esté impacientando, pero aun así quiero mencionarla aquí: la clase que usa esta anotación representa una clase de configuración y la clase en sí también es un bean. En esta clase también puede cargar beans mediante la anotación @Bean
9. @Bean
La anotación @Bean indica que el objeto del método se inyecta en el contenedor de Spring, y resulta cómodo extraer después el objeto del contenedor para simplificar el desarrollo. Suele usarse junto con la anotación @Configuration. Seguramente esta anotación le resulta familiar, así que no me extenderé más aquí~
Ahora que ya hablamos de los complementos de paginación, veamos su uso básico.
@Test
void test01() {
//Establece los parámetros de paginación
Page
userMapper.selectPage (page, null);
//Obtiene los datos de la paginación
List
list.forEach ( System.out :: println );
System.out.println ("Current page:" + page.getCurrent ());
System.out.println ("Number of items displayed per page: " + page.getSize ());
System.out.println ("Total records:" + page.getTotal ());
System.out.println ("Total pages: " + page.getPages ());
System.out.println ("Is there a previous page:" + page.hasPrevious ());
System.out.println ("Whether there is a next page: " + page.hasNext ());
}
Resultado de la operación:
10. @Param
Cuando uso una sentencia de paginación personalizada:
@Mapper
@Repository
public interface UserMapper extends BaseMapper
/**
* Consulta la información de usuarios por edad y realiza la paginación
* @param page
* @param age
* @return
*/
Page
}
@Param es proporcionada por MyBatis. Como anotación de la capa Dao, sirve para pasar parámetros de modo que correspondan con el nombre del campo en SQL, lo que simplifica el desarrollo~
11. @Version
Al estudiar el bloqueo optimista, seguramente ha visto el siguiente código:
@Data
@TableName("t_product")
public class Product {
private Long id;
private String name;
private Integer price;
@Version
private Integer version;
}
@Configuration
public class MybatisPlusConfig {
@Bean
public MybatisPlusInterceptor mybatisPlusInterceptor() {
MybatisPlusInterceptor interceptor =
new MybatisPlusInterceptor ( );
//Complemento de paginación
interceptor.addInnerInterceptor
(new PaginationInnerInterceptor ( DbType.MYSQL ));
//Complemento de bloqueo optimista
interceptor.addInnerInterceptor (new OptimisticLockerInnerInterceptor ());
return interceptor;
}
}
Y esta anotación @Version es una anotación importante para implementar el bloqueo optimista. Cuando se van a actualizar los datos de la base de datos, como el precio, la versión se incrementa en 1. Si la versión en la sentencia where no es correcta, la actualización fallará.
Anotaciones comunes de MyBatis. @EnumValue
@Getter
public enum SexEnum {
MALE(1, "男"),
FEMALE(2, "女");
@EnumValue
private Integer sex;
private String sexName;
SexEnum(Integer sex, String sexName) {
this.sex = sex;
this.sexName = sexName;
}
}
mybatis -plus:
global-config:
banner: false
db -config:
# Configura el prefijo por defecto de la tabla que opera MyBatis-Plus
table-prefix: "t_"
# Configura la estrategia de clave primaria de MyBatis-Plus
id-type: auto
# Configura los logs de MyBatis
configuration:
log - impl : org.apache.ibatis.logging.stdout.StdOutImpl
# Configura el paquete que corresponde al alias de tipo
type-aliases-package: cabbage.pojo
# Configura el escaneo de enumeraciones
type- enums - package: cabbage.pojo
El valor del atributo identificado por la anotación @EnumValue se almacenará en la base de datos, lo que equivale a la sentencia INSERT INTO t_user ( username, age, sex ) VALUES ( ?, ?, ? )
Parámetros: Enum ( String), 20(Integer), 1(Integer)
4. Anotaciones comunes de MyBatis. Resumen
Bueno, amigos, con esto prácticamente quedan explicadas las anotaciones comunes de MyBatis-Plus. Creo que ya ha sentido el cómodo respaldo de este marco de trabajo nacional (de origen chino). Espero que lo apoye activamente. Si considera que la redacción del autor no está mal, puede darle al autor el triple apoyo consecutivo ~~
Artículos relacionados
-
6 tecnologías opcionales de datos
Equipo Conocimiento
Ver más ofertas especiales
-
Short Message Service (SMS) & Mail Service
Paquete de 50,000 correos desde USD $1.99; 120 SMS por solo USD $1.00