SpringBootはMyBatisをすばやく統合します

人工知能、ゼロベースのエントリー!http://www.captainbed.net/inner 

はじめに: MyBatis3が提供するアノテーションを使用すると、XMLを徐々に置き換えることができます。たとえば、@ Selectアノテーションを使用してSQLを直接記述してデータクエリを完了すると、@ SelectProvider高度なアノテーションを使用して動的SQLを記述し、複雑なビジネスニーズを満たすことができます。

1.基本的な注意事項

MyBatisは、主に次のCRUDアノテーションを提供します。

@選択する

@インサート

@更新

@削除

追加、削除、変更、およびチェックは、ほとんどの業務を占めます。これらの基本的な注釈の使用を習得する必要があります。たとえば、次のコードは、XMLなしでデータクエリを完了できます。

@Mapper
public interface UserMapper {
   @Select("select * from t_user")
   List<User> list();
}

Hibernateを使用したことのある学生は興味があるかもしれませんが、ここでマッピング関係を構成せずにプロパティインジェクションを完了できるのはなぜですか?従来のプロジェクトでMybatisを使用していた子供靴は、構成ファイルでグローバルハンプマッピングがオンになっているため、すぐに反応する可能性があります。これは、SpringBootでも実行でき、よりシンプルで高速です。

グローバルキャメルケースマッピングは有効になっていますが、フィールドがキャメルケースへのアンダースコアのルールに準拠していない場合、クエリによって返されるエンティティオブジェクト属性は、上記のユーザーオブジェクト属性のようにnullとして取得されることに疑問があるかもしれません。 mobileNumおよび対応するデータベースフィールドphoneNumの場合、クエリ結果は次のようになります。

[
 {
   "userId": "1",
   "username": "admin",
   "password": "admin",
   "mobileNum": null
 },
 {
   "userId": "2",
   "username": "roots",
   "password": "roots",
   "mobileNum": null
 }
]

オブジェクト属性とフィールドラクダの間の不整合の問題を解決するために、マッピングアノテーション@Resultsを使用してマッピング関係を指定できます。

2.注釈のマッピング

Mybatisは主に次のマッピングアノテーションを提供します。

@Resultsは、結果セット内の複数のフィールドのマッピング関係を入力するために使用されます。

@Resultは、結果セットの単一フィールドのマッピング関係を入力するために使用されます。

@ResultMapは、IDに従ってXMLの<resultMap>を関連付けます。

たとえば、上記のlistメソッドでは、SQLのクエリに基づいて、返される結果セットのマッピング関係を指定できます。ここで、propertyはエンティティオブジェクトの属性名を表し、columnは対応するデータベースフィールド名を表します。

@Results({
           @Result(property = "userId", column = "USER_ID"),
           @Result(property = "username", column = "USERNAME"),
           @Result(property = "password", column = "PASSWORD"),
           @Result(property = "mobileNum", column = "PHONE_NUM")
   })
   @Select("select * from t_user")
   List<User> list();

クエリ結果は次のとおりです。

[
 {
   "userId": "1",
   "username": "admin",
   "password": "admin",
   "mobileNum": "15011791234"
 },
 {
   "userId": "2",
   "username": "roots",
   "password": "roots",
   "mobileNum": "18812342017"
 }
]

オブジェクト属性とフィールドラクダの間の不整合の問題を解決するために、マッピングアノテーション@Resultsを使用してマッピング関係を指定できます。

デモンストレーションを容易にし、マッピング関係を手動で作成する手間を省くために、マッピング結果セットをすばやく生成する方法を次に示します。具体的な内容は次のとおりです。

/**
    * 1.用于获取结果集的映射关系
    */
   public static String getResultsStr(Class origin) {
       StringBuilder stringBuilder = new StringBuilder();
       stringBuilder.append("@Results({\n");
       for (Field field : origin.getDeclaredFields()) {
           String property = field.getName();
           //映射关系:对象属性(驼峰)->数据库字段(下划线)
           String column = new PropertyNamingStrategy.SnakeCaseStrategy().translate(field.getName()).toUpperCase();
           stringBuilder.append(String.format("@Result(property = \"%s\", column = \"%s\"),\n", property, column));
       }
       stringBuilder.append("})");
       return stringBuilder.toString();
   }

現在のMainメソッドの実行効果は次のとおりです。次に、コンソールの印刷情報のこのセクションをinterfaceメソッドにコピーします。

 

3.高度な注釈

MyBatis-3は、​​主にCRUDの次の高度な注釈を提供します。

@SelectProvider

@InsertProvider

@UpdateProvider

@DeleteProvider

名前が示すように、これらの高度なアノテーションは主に動的SQLに使用されます。ここでは、@ SelectProviderを例として取り上げます。これには、主に2つのアノテーション属性が含まれます。typeはツールクラスを表し、methodはツールクラスのメソッドを表します。特定のSQLを返すために使用されます。

@Mapper
public interface UserMapper {
   @SelectProvider(type = UserSqlProvider.class, method = "list222")
   List<User> list2();
}

ツールコードは次のとおりです。

public class UserSqlProvider {
   public String list222() {
       return "select * from t_user ;
   }

4.詳細なチュートリアル

上記のアノテーションを理解した後、特定のプロジェクトケースを使用して、これらのアノテーションの実際の使用をさらに統合します。

1.依存関係を導入する

デモンストレーションを容易にするために、最初の選択肢はWeb環境を構築することであり、データベースはMysql5.5以降を選択します。

<dependencies>
       <dependency> <!--添加Web依赖 -->
           <groupId>org.springframework.boot</groupId>
           <artifactId>spring-boot-starter-web</artifactId>
       </dependency>
       <dependency> <!--添加Mybatis依赖 -->
           <groupId>org.mybatis.spring.boot</groupId>
           <artifactId>mybatis-spring-boot-starter</artifactId>
           <version>1.3.1</version>
       </dependency>
       <dependency><!--添加MySQL驱动依赖 -->
           <groupId>mysql</groupId>
           <artifactId>mysql-connector-java</artifactId>
           <scope>runtime</scope>
       </dependency>
       <dependency><!--添加Test依赖 -->
           <groupId>org.springframework.boot</groupId>
           <artifactId>spring-boot-starter-test</artifactId>
           <scope>test</scope>
       </dependency>
   </dependencies>

 

2.構成を追加します

ここでの主な目的は、データソースを追加し、キャメルケースマッピングを構成し、SQLログのコンソール印刷を有効にすることです。プロジェクトのリソースディレクトリに、次のようにapplication.yml構成を追加します。

spring:
 datasource:
   #连接MySQL
   url: jdbc:mysql://localhost:3306/socks?useSSL=false
   username: root
   password: root
   driver-class-name: com.mysql.jdbc.Driver

mybatis:
 configuration:
  #配置项:开启下划线到驼峰的自动转换. 作用:将数据库字段根据驼峰规则自动注入到对象属性。
  map-underscore-to-camel-case: true

logging:
 level:
  #打印SQL信息
  com.hehe.mapper: debug

3.データレイヤーコードを書く

ここでは、使い慣れたユーザー情報を例として取り上げ、この場合に使用されるUserMapperインターフェイスとUserSqlProviderを記述します。

3.1 UserMapper

データクエリ用のUserMapperインターフェイスを追加します。

package com.hehe.mapper;
@Mapper
public interface UserMapper {
   /**
    * 方式1:使用注解编写SQL。
    */
   @Select("select * from t_user")
   List<User> list();

   /**
    * 方式2:使用注解指定某个工具类的方法来动态编写SQL.
    */
   @SelectProvider(type = UserSqlProvider.class, method = "listByUsername")
   List<User> listByUsername(String username);

   /**
    * 延伸:上述两种方式都可以附加@Results注解来指定结果集的映射关系.
    *
    * PS:如果符合下划线转驼峰的匹配项可以直接省略不写。
    */
   @Results({
           @Result(property = "userId", column = "USER_ID"),
           @Result(property = "username", column = "USERNAME"),
           @Result(property = "password", column = "PASSWORD"),
           @Result(property = "mobileNum", column = "PHONE_NUM")
   })
   @Select("select * from t_user")
   List<User> listSample();

   /**
    * 延伸:无论什么方式,如果涉及多个参数,则必须加上@Param注解,否则无法使用EL表达式获取参数。
    */
   @Select("select * from t_user where username like #{username} and password like #{password}")
   User get(@Param("username") String username, @Param("password") String password);

   @SelectProvider(type = UserSqlProvider.class, method = "getBadUser")
   User getBadUser(@Param("username") String username, @Param("password") String password);

}

3.2 UserSqlProvider

SQLの生成に使用されるツールクラスであるUserSqlProviderを追加します。

/**
* 主要用途:根据复杂的业务需求来动态生成SQL.
* <p>
* 目标:使用Java工具类来替代传统的XML文件.(例如:UserSqlProvider.java <-- UserMapper.xml)
*/
public class UserSqlProvider {
   /**
    * 方式1:在工具类的方法里,可以自己手工编写SQL。
    */
   public String listByUsername(String username) {
       return "select * from t_user where username =#{username}";
   }

   /**
    * 方式2:也可以根据官方提供的API来编写动态SQL。
    */
   public String getBadUser(@Param("username") String username, @Param("password") String password) {
       return new SQL() {
   
   {
           SELECT("*");
           FROM("t_user");
           if (username != null && password != null) {
               WHERE("username like #{username} and password like #{password}");
           } else {
               WHERE("1=2");
           }
       }}.toString();
   }
}

3.3エンティティクラスユーザー

エンティティクラスUserを追加します

public class User {
   private String userId;
   private String username;
   private String password;
   private String mobileNum;
   //Getters & Setters
}

3.4データベースレコードを追加する

Navicatクエリウィンドウを開き、次のスクリプトのみが必要です。

USE `SOCKS`;
DROP TABLE IF EXISTS `t_user`;
CREATE TABLE `t_user` (
 `USER_ID` varchar(50) ,
 `USERNAME` varchar(50) ,
 `PASSWORD` varchar(50) ,
   `PHONE_NUM` varchar(15) 
) ;

INSERT INTO `t_user` VALUES ('1', 'admin', 'admin','15011791234');
INSERT INTO `t_user` VALUES ('2', 'roots', 'roots','18812342017');

4.制御層コードを記述します

package com.hehe.controller;

@RestController
@RequestMapping("/user/*")
public class UserController {

   @SuppressWarnings("all")
   @Autowired
   UserMapper userMapper;

   @GetMapping("list")
   public List<User> list() {
       return userMapper.list();
   }

   @GetMapping("list/{username}")
   public List<User> listByUsername(@PathVariable("username") String username) {
       return userMapper.listByUsername(username);
   }

   @GetMapping("get/{username}/{password}")
   public User get(@PathVariable("username") String username, @PathVariable("password") String password) {
       return userMapper.get(username, password);
   }

   @GetMapping("get/bad/{username}/{password}")
   public User getBadUser(@PathVariable("username") String username, @PathVariable("password") String password) {
       return userMapper.getBadUser(username, password);
   }
}

5.起動とテスト

プロジェクトを開始した後、http:// localhost:8080 / user / listにアクセスして、次のようにユーザーリストを表示します。

http:// localhost:8080 / user / list / adminにアクセスして、ユーザー名adminの情報を照会します。

おすすめ

転載: blog.csdn.net/qq_35860138/article/details/102677804