モノリシックアーキテクチャから分散データ永続化へ、ORMフレームワークMybatis

[[377400]]

この記事はWeChatの公開アカウント「Uncle Who Knows a Little Code」から転載したもので、著者はUncle Who Knows a Little Codeです。この記事を転載する場合は、Uncle Who Knows Codeの公式アカウントまでご連絡ください。

1 プレコンセプト

01 粘り強さ

永続性とは、ディスクなどの永続的に保存できるストレージデバイスにデータを保存することを意味します。

02 ＪＤＢＣ

Java を学習する場合、ほとんどのプログラマーは、Java を使用してデータベースにアクセスする方法を学ぶときに、最初に JDBC を学習します。 JDBC は、SQL ステートメントを実行し、データベースへの統一されたアクセスを提供し、データベースにデータを「保持」するために使用される Java API です。

簡単に説明しましょう (JDBC についてある程度の知識がある方は読み飛ばしてください)。

Sun は 1998 年に JDK1.1 をリリースしました。JDBC はこのバージョンにおける重要な技術ポイントです。 Java 言語を使用してデータベースに接続する場合、通常は、Sun がデータベースへの接続方法と SQL ステートメントの実行方法を実現すると考えられています。しかし、市場にはデータベースが多すぎて、データベース間の違いも非常に大きくなっています。さらに、Sun が各データベースの内部詳細を理解することは不可能です...

Java コードがデータベースにうまく接続できるようにするために、Sun は一連のインターフェースを開発しました。インターフェースと呼ばれていますが、実際には一連の標準と仕様です。コードの具体的な実装は各データベースベンダーによって作成されます。したがって、私たちがよく呼ぶ「ドライバークラス」は、各ベンダーの実装クラスです。

したがって、JDBC を使用してデータベースに接続する場合、最初のステップはドライバーを登録すること、つまり、使用するデータベース実装クラスを JVM に指示することです。

03 オーム

ORM フレームワークが登場する前は、次のようにデータベースを操作していました。

JDBC を使用してデータベースを操作する場合、コードが煩雑になり、SQL のパラメータのスペルにエラーが発生しやすくなり、読みやすさが悪くなるため、コードのメンテナンスが難しくなることがわかります。

ORM フレームワークを使用すると、データベースを次のように操作します。

ORM フレームワークは、Java オブジェクトとデータベーステーブル間のマッピングを作成し、データベースアクセスの詳細をカプセル化します。データベースステートメントを操作する必要がある場合は、Java オブジェクトを直接操作できます。

2. Spring BootはMyBatisを統合する

Java でよく使用される ORM フレームワークには、Hibernate、MyBatis、JPA などがあります。次のテキストでは、これらのフレームワークの長所と短所を比較します。この章では、主に、Spring Boot プロジェクトに MyBatis を統合してデータベースにアクセスする方法について説明します。

ステップ1.依存関係を追加する

<依存関係>
    <グループID>mysql</グループID>
    <artifactId>mysql-コネクタ-java</artifactId>
 </依存関係> 
 
 <依存関係>
    <グループ ID>org.mybatis.spring.boot</グループ ID>
    <artifactId>mybatis-spring-boot-starter</artifactId>
    <バージョン>2.0.1</バージョン>
 </依存関係>

ステップ2. データベースリンクを構成する

application.yml ファイルでデータベース関連情報を構成します。

 #データソースの構成
春：
  データソース:
    #データベースドライバー
    ドライバークラス名: com.mysql.cj.jdbc.Driver
    #データベース URL
    URL: jdbc:mysql://127.0.0.1:3306/arch?characterEncoding=UTF-8&serverTimezone=UTC
    #ユーザー名
    ユーザー名: root
    ＃パスワード
パスワード: root

ステップ3. データベースリンクを構成する

ローカルデータベースで、ユーザーテーブルを作成し、データを挿入します。

作成する テーブルが存在しない場合は` user` (
   `id` INT UNSIGNED AUTO_INCREMENT、
   `userid` VARCHAR (100) NOT   NULL 、
   `username` VARCHAR (100) NOT   NULL 、
   `性別` CHAR (1) NOT   NULL 、
   `年齢` INT  ない  NULL 、
主要な キー( `id` )
 )ENGINE=InnoDBデフォルト文字セット=utf8; 
 
入れる の中へ ユーザー（ユーザーID、ユーザー名、性別、年齢）値（ 'dashu' 、 'Uncle' 、 'M' 、18）;

ステップ4. モデルレイヤーを作成する

通常、データベースからデータを受け取るオブジェクトの場合は、別のモデルパッケージを作成し、クラス内の属性とフィールドを同じに保つことに慣れています。

パッケージ com.archevolution.chapter4.model; 
 
パブリッククラスUser {
  プライベートint id; //主キーID、自己増分
  プライベート文字列ユーザーID; //ユーザーIDまたはログイン名
  プライベート文字列userName; //ユーザー名
  プライベート文字列性別; //性別
  プライベートint年齢; //年
  //get、 set 、toStringメソッドを省略
}

ステップ5. Daoレイヤーを作成する

通常、データベースを直接処理するコードは、すべてのデータアクセスロジックが配置されている DAO レイヤー (データアクセスオブジェクト) に配置します。

新しい dao パッケージを作成し、その下に新しい **interface** を作成します。これはインターフェースであることに注意してください。

 @マッパー
パブリックインターフェースUserDao{
  @ Select ( "SELECT id, userId, userName, gender, age FROM USER WHERE id = #{id}" )
公共 ユーザーqueryUserById(@Param( "id" ) int id);
 }

ここでもう少しだけ言わせてください!

技術的な観点から見ると、モデル内の属性はテーブル内のフィールドとは異なる場合があります。たとえば、データベースに [mobilephone] という携帯電話番号フィールドを追加します。

 --携帯電話番号フィールドを追加 
変更 テーブル ユーザー  ADD携帯電話varchar (15); 
 
 --userid = 1 の携帯電話番号のデータを更新します 
アップデート ユーザー 携帯電話を'13800000000'に設定 ここで、 userid = '1'です。

User.java に [telephone] というフィールドを追加します。

[telephone] がデータベース内の [mobilephone] に対応していることはわかっていますが、これら 2 つのフィールドが対応していることを Mybatis に知らせるにはどうすればよいでしょうか。いくつかの方法があります:

01. SQL ステートメントで制御し、異なる名前のフィールドにエイリアスを付与します。

 @ Select ( "SELECT id、userId、userName、gender、age、mobilephone (電話) FROM USER WHERE id = #{id}" )
公共 ユーザーqueryUserTelById(@Param( "id" ) int id);

02. @Results タグを使用して、異なる設定を持つプロパティとフィールドをマップします (同じ名前のものは省略できます)。

 @ Select ( "SELECT id、userId、userName、gender、age、mobilephone FROM USER WHERE id = #{id}" )
 @結果（{
  @Result(プロパティ = "電話" 、列= "携帯電話" )
 })
公共 ユーザークエリUserTelById2(@Param( "id" ) int id);

ただし、モデルクラスを記述するときには、属性をテーブル内のフィールドとまったく同じに保つことをお勧めします。これにより、コードの複雑さが軽減されるだけでなく、コードの可読性が大幅に向上し、エラーの可能性も減ります。

質問がある生徒もいるかもしれません。多くのプロジェクトのデータ構造設計はそれほど標準化されていません。たとえば、フィールド名は flag01、flag02 など、非常に奇妙な名前になる場合があります。このようなフィールドがデータベースから照会され、インターフェースを通じて返されると、インターフェースの読みやすさが極端に悪くなるでしょうか?

通常、モデルの内容を直接パッケージ化して返すことはありません。多くのモデルはデータベースと Java オブジェクト間のマッピングであり、通常、データ転送には DTO が必要です。データベースからデータをクエリし、それをモデルに格納します。インターフェイスでデータを返す前に、モデルを DTO に変換し、DTO 内の属性の標準化と意味の明確化を確保する必要があります。

ステップ6. サービス層を作成する

これで、プロジェクトには、データにアクセスするための Dao レイヤーと、ユーザー提供のインターフェースアクセスを提供するためのコントローラーレイヤーが追加されました。では、コントローラーは Dao 内のメソッドを直接呼び出すことができるのでしょうか?直接電話しないほうがいいですよ！

通常、ビジネスロジックを保存するためにサービスレイヤーを作成します。現時点での完全な呼び出しプロセスは次のとおりです。

コントローラー - サービス - Dao

Service パッケージを作成したら、その中に UserService を作成します。

 @サービス
パブリッククラスUserService{
  オートワイヤード
  ユーザーDao ユーザーDao; 
 
公共 ユーザークエリUserById( int id) {
 userDao.queryUserById(id)を返します;
  }
 }

ステップ7. コントローラー層にインターフェースを追加する

ユーザー ID で顧客情報を照会し、顧客情報を返すインターフェースを追加します。

 @RequestMapping(値 = "/queryUser/{id}" )
 @レスポンス本文
public String queryUserById(@PathVariable( "id" ) int id){
ユーザー ユーザー= userService.queryUserById(id);
戻る ユーザー== null ? "ユーザーが見つかりません" : user .toString() ;
 }

ステップ8. テストと検証

デバッグやテストのためにブラウザまたはクライアントのインターフェースにアクセスし、顧客情報を照会できます。

 http://127.0.0.1:8088/queryUser/1 
 
ユーザー[id=1、userId=dashu、userName=uncle、性別=M、年齢=18、電話= null ]

03MyBatisのその他の操作

キーコードのみが提供されます。完全なコードについては、この章のプロジェクトコードを参照してください。

01. 追加

@Insert ( " INSERT INTO USER(userId, userName, gender, age) の値"  
        + " (#{userId}, #{userName}, #{gender}, #{age})" )
パブリックvoid insertUser(ユーザー ユーザー);

02. 変更

@更新( "UPDATE USER SET mobilephone = #{telephone} WHERE id = #{id}" )
パブリックvoid updateUserTel(ユーザー ユーザー);

03. 削除

@削除( "ID = #{id} のユーザーから削除" )
パブリックvoid deleteUserById(@Param( "id" ) int id);

4. コードの改善

上記では、Spring Boot と MyBatis の最も単純な統合が完了し、CRUD 用にデータベースを正常に読み取ることができるようになりました。ただし、これは最も単純な統合であるため、次のような改善が必要な詳細がいくつかあります。

パラメータはすべて URL に表示されます。

Object.toString() を直接返しますが、これはあまり使いやすくありません。

データが見つからなかったか例外が発生し、特別な処理は行われませんでした。

少しずつ改善していきましょう

01. JsonをパラメータとしてPostリクエストを送信する

RESTful スタイルに厳密に従う場合は、次の点に従う必要があります。

クエリ: GET /url/xxx

新規: POST /url

変更: PUT /url/xxx

削除: DELETE /url/xxx

ここでは単純に URL にパラメータを記述することでパラメータの内容を一目で確認しやすく、パラメータが増えると URL が長くなりすぎるため、通常は Json をパラメータとして使用して Post リクエストを送信することに慣れています。たとえば、新しいユーザーを追加するためのインターフェースは次のように記述できます。

新しい DTO パッケージを追加し、新しい UserDTO を作成します。

 //Josn をパラメータとして使用する場合は、headers = { "content-type=application/json" }を設定する必要があります。
 //@RequestBody UserDto userDto はJSON文字列を自動的にバインドしてUserDtoに変換します
@RequestMapping(値 = "/insertUser2" 、ヘッダー = { "content-type=application/json" })
 @レスポンス本文
パブリック文字列 insertUser2(@RequestBody UserDto userDto){
    //DTO をモデルに変換
ユーザー ユーザー= 新しいユーザー();
ユーザー.setUserId(userDto.getUserId());
ユーザー.setUserName(userDto.getUserName());
ユーザーの性別を設定します。
ユーザー.setAge(userDto.getAge()); 
 
    userService.insertUser(ユーザー); 
 
戻る  "成功" ;
 }

ユーザーインターフェイスが追加されました:

 //Josn をパラメータとして使用する場合は、headers = { "content-type=application/json" }を設定する必要があります。
 //@RequestBody UserDto userDto はJSON文字列を自動的にバインドしてUserDtoに変換します
@RequestMapping(値 = "/insertUser2" 、ヘッダー = { "content-type=application/json" })
 @レスポンス本文
パブリック文字列 insertUser2(@RequestBody UserDto userDto){
    //DTO をモデルに変換
ユーザー ユーザー= 新しいユーザー();
ユーザー.setUserId(userDto.getUserId());
ユーザー.setUserName(userDto.getUserName());
ユーザーの性別を設定します。
ユーザー.setAge(userDto.getAge()); 
 
    userService.insertUser(ユーザー); 
 
戻る  "成功" ;
 }

インターフェースを呼び出してテストしてみましょう:

 {
 「ユーザーID」 : 「lisi」 、
 「ユーザー名」 : 「李思」 、
 「性別」 : 「F」 、
 「年齢」 : 「40」 、
 「電話」 ： 「186000000000」  
 }

02. 標準化された戻りパラメータ

Object.toString() を直接返しますが、これはあまり使いやすくありません。

コード (ステータスコード)、メッセージ (例外情報の説明)、データ (データ) を含む単純な戻り参照オブジェクトを設計してみましょう。

パブリッククラスJsonResponse{
  プライベート文字列コード;
  プライベート文字列メッセージ;
  プライベートオブジェクトデータ。
  // setメソッドとgetメソッドを省略
}

コードについては、Http ステータスコードを参照し、よく使用されるコードをいくつか使用します。

パブリッククラスResponseCode{
公共 静的最終文字列 SUCCESS = "200" ; //クエリ成功
公共 静的最終文字列 SUCCESS_NULL = "204" ; //クエリは成功しましたが、データがありません
公共 静的最終文字列PARAMETERERROR = "400" ; //パラメータエラー
公共 静的最終文字列 FAIL = "500" ; //サーバー例外
}

今回は、クエリインターフェースを書き直してみましょう。

 @RequestMapping(値 = "/queryUser2" )
 @レスポンス本文
パブリックJsonResponse queryUser2ById(@RequestBody UserDto userDto){
  JsonResponse res = 新しい JsonResponse(); 
 
  //パラメータ検証を省略
 
ユーザー ユーザー= userService.queryUserById(userDto.getUserId()); 
 
  if(ユーザー!= null ){
    //結果をクエリし、それを戻りパラメータにカプセル化できます
    res.setCode(レスポンスコード.SUCCESS);
    res.setData(ユーザー);
  }それ以外{
    //結果が見つからない場合は'204'を返します 
    res.setCode(レスポンスコード.SUCCESS_NULL);
    res.setMessage( "データが見つかりません" );
  } 
 
 resを返します。
 }

呼び出し結果には、カプセル化された戻りパラメータが表示されます。これは、はるかに標準化されているようです。

 {
 「コード」 : 「200」 、
 "メッセージ" : null 、
 "データ" ： {
 「id」 : 3,
 「ユーザーID」 : 「lisi」 、
 「ユーザー名」 : 「李思」 、
 「性別」 : 「F」 、
 「年齢」 : 40,
 「電話」 : null  
   }
 }

03. 例外処理

コードの実行中に例外が発生した場合、どのように処理すればよいでしょうか?例外情報はフロントエンドに直接返されるべきでしょうか?これは発信者にとってあまり親切ではありません。通常、エラーログをローカルに出力し、呼び出し元に例外ステータスコードを返します。

サービス層と Dao 層の統合は上向きに行われます。

公共 ユーザーqueryUserById( int userId) は例外をスローします{
 userDao.queryUserById(userId)を返します。
 }

コントローラー層で例外をキャッチし、戻りパラメータをカプセル化します。

ユーザー ユーザー= 新しいユーザー();
試す {
ユーザー= userService.queryUserById(userDto.getId());
 } キャッチ (例外 e) {
  res.setCode(レスポンスコード.FAIL);
  res.setMessage( "サービス例外" );
 }

4MyBatis よくある質問

01. MyBatis が半自動 ORM フレームワークと呼ばれるのはなぜですか?

半自動もあれば、全自動もあるでしょう。

Hibernate は完全に自動化された ORM フレームワークです。 Hibernate を使用すると、オブジェクトリレーショナルモデルに完全に従って操作できるため、Java オブジェクトを操作するために SQL を記述する必要がなく、完全に自動化されます。一方、MyBatis では、オブジェクトを関連付けるときに SQL ステートメントを手動で記述する必要があるため、「半自動」と呼ばれます。

02. 注釈か XML か?

MyBatis を使用するほとんどのプロジェクトでは、SQL ステートメントを構成するために XML が使用されていますが、このコースの例ではすべてアノテーションが使用されていると思います。では、この2つの違いは何でしょうか?実際の開発ではどのように選択するのでしょうか?

まず、アノテーションを使用して動的 SQL を接合することがより困難であるため、公式には XML を使用することが推奨されています。 SQL がより複雑で、複数のテーブルの関連付けが必要な場合は、XML を使用する方が適切です。そして現在では、MyBatis XML を自動的に生成できるプラグインが数多く存在します。

しかし、コインには常に表と裏がある。複雑な SQL は誇るべきものではありません。複雑な SQL を使用せずにプロジェクトを実行できる場合は、アノテーションを使用する方が適しています (現在のプロジェクトの SQL の 95% 以上は単一テーブルクエリです)。

03. #{} と ${} の違いは何ですか?

${} は文字列の置換、#{} はコンパイル前の処理です。 #{} を使用すると、SQL インジェクションを防ぎ、システムのセキュリティを向上できます。

04. バッチ挿入を行うにはどうすればいいですか?

アノテーションメソッドでは動的 SQL も使用できます。

 @入れる（ {
 「<スクリプト>」  
        + "INSERT INTO USER(userId, userName, gender, age) 値"  
        + "<foreach コレクション='userList' 項目='item' インデックス='index' セパレーター=','>"  
        + " (#{item.userId}, #{item.userName}, #{item.gender}, #{item.age})"  
        + "</foreach>"  
        + "</script>"  
 })
パブリックvoid insertUserList(@Param(value= "userList" ) List< User > userList);