[Java] 60. Spring bootでApacheの連結とロードバランシングを設定する方法

Study / Java 作成日付 : 2022/02/28 18:45:48 修正日付 : 2022/02/28 18:46:57

こんにちは。明月です。

この投稿はSpring bootでApacheの連結とロードバランシングを設定する方法に関する説明です。

Spring bootにはTomcatが内蔵しているので、すぐビルドして配布してもウェブサーバーで運用可能です。つまり、複雑なTomcat設定が必要ないです。

このウェブというのはブラウザから要請と応答処理で接続からパーシングまで様々な処理があります。でもトラフィック(接続者)が多くなるとTomcatサーバーだけでは足りないので、ApacheとTomcatで分割して役割を割り振りします。

役割というのはブラウザの要請と応答処理、様々なプロトコール処理をApacheに任せて、TomcatはHtmlパーシングとセッション管理の役割をします。

それでApacheサーバーとTomcatサーバーを連結する方法がありますが、以前の投稿でApacheとTomcatを連結する方法に関して説明したことがあります。

リンク - [CentOS] ApacheとTomcatの連携

でも、Spring bootにはTomcatがフレームワークの中で含めている形になっています。それでTomcatの設定(以前のserver.xml)をプロジェクトの中で設定しなければならないです。

まず、以前のプロジェクトから@Configurationアノテーションを宣言したAJPConfigクラスファイルを生成しましょう。

package com.example.demo.Controller;

import org.apache.catalina.connector.Connector;
import org.apache.coyote.ajp.AbstractAjpProtocol;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.web.embedded.tomcat.TomcatServletWebServerFactory;
import org.springframework.boot.web.servlet.server.ServletWebServerFactory;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

// 設定クラス
@Configuration
public class AJPConfig {
  // application.propertiesから設定値を受け取る。
  @Value("${tomcat.ajp.port}")
  private int port;
  // bean設定
  @Bean
  public ServletWebServerFactory servletContainer() {
    // AJP/1.3プロトコールのConnectorを生成
    var ajpConnector = new Connector("AJP/1.3");
    // ポート設定をapplication.propertiesで設定
    ajpConnector.setPort(port);
    // ajpログ、以前のserver.xmlのallowTraceアトリビュート設定
    ajpConnector.setAllowTrace(false);
    // httpとhttps処理、現在は要らないのでコメント
    // ajpConnector.setScheme("http");
    // SSL連結する時に使う
    // ajpConnector.setSecure(false);
    // server.xmlからsecretRequired設定
    ((AbstractAjpProtocol<?>)ajpConnector.getProtocolHandler()).setSecretRequired(false);
    // tomcat設定
    var tomcat = new TomcatServletWebServerFactory();
    // 追加
    tomcat.addAdditionalTomcatConnectors(ajpConnector);
    
    return tomcat;
  }
}

AJPConfigクラスを上みたいに作成してapplication.propertiesにtomcat.ajp.portを追加しましょう。

# サーバーポート設定
server.port=8081
# ajpポート設定
tomcat.ajp.port=9091

Apache設定の場合あｈmod_jk.soファイルをインストールしてhttpd.configファイルを修正するし、workers.propertieファイルを追加します。(windowの場合あｈApache Loungeからダウンロードします。リンク - https://www.apachelounge.com/download/)

# モードロード
LoadModule jk_module modules/mod_jk.so
# モード設定
<IfModule mod_jk.c>
  JkWorkersFile conf/workers.properties
  JkShmFile run/mod_jk.shm
  JkLogFile logs/mod_jk.log
  JkLogLevel info
  JkLogStampFormat "[%y %m %d %H:%M:%S] "
</IfModule>	
# 80 ポートの場合
<VirtualHost *:80>
  JkMount /* springboot
  JkMount /jkmanager/* jkstatus
  ServerName localhost
</VirtualHost>
# 仮想ディレクトリのjkmanagerで接続する場合
<Location /jkmanager/>
  JkMount statusmanager
  # ローカルだけ接続
  Require ip 127.0.0.1
</Location>

# リストキー
worker.list=springboot,jkstatus
# ロードバランシング状態
worker.jkstatus.type=status 
# ajpポート
worker.springboot.port=9091
# ホスト名
worker.springboot.host=localhost
# タイプ
worker.springboot.type=ajp13
# 不可分散比率
worker.springboot.lbfactor=1

これからApacheを起動してイクリプスからSpring bootを起動しましょう。

ajpプロトコールが起動されることを確認できます。

Apacheで80を接続するとTomcatと連結したことを確認できます。

でも、トラフィック(接続者)がもっと増えてApacheとTomcatだけで足りない時期が来ました。そうすると普通のウェブ要請と応答処理で一番時間が掛かる部分がTomcatのHtmlパーシング部分です。

仕様によりその結果がいつも違うので要請によるHtmlを作成するからです。そうするとApacheとTomcat環境でTomcatを複数に増やして一つのApacheに連結しますが、それをロードバランシングと言います。

これからこのプロジェクトを二つのTomcatサーバーに分けてApacheからロードバランシングしましょう。

まず、二つのサーバーが作動することを確認するため、index画面を修正します。

package com.example.demo.Controller;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.RequestMapping;

// コントローラーアトリビュート
@Controller
// Controllerクラス
public class HomeController {
  // application.propertiesから設定値を受け取る。
  @Value("${tomcat.ajp.port}")
  private int port;

  // マッピングアドレス
  @RequestMapping(value = { "/", "/index.html" })
  public String index(Model model) {
    // ポートデータをテンプレートに渡す
    model.addAttribute("data", port);
    // テンプレートファイル名
    return "Home/index";
  }
}

画面にapplication.propertiesで設定するajpポート番号を画面に表示することで修正しましょう。

そして、イクリプスでは二つのサーバーを起動することができないので、テストが可能なディレクトリにソースをコピーしましょう。

私はdドライブのworkフォルダにコピーしました。

そして各フォルダのapplication.propertiesにhttpを8081と8082で設定するし、ajpを9091と9092で設定して重ならないように設定しましょう。

設定をしてウィンドウの場合はプロジェクトでmvnw.cmdファイルがありますが、それを利用してビルドして実行しましょう。

mvnw clean install spring-boot:run

テストが実行してログメッセージが表示しますが、エラーが発生しないと正常に実行されたことです。

一応、Tomcatを実行されてますが、ロードバランシングのため、Apache設定を修正して実行しましょう。

# work リスト
worker.list=springboot,jkstatus
# apacheに連結されているmod_jkに関する状況(ロードバランシング表示)
worker.jkstatus.type=status
# type lbはロードバランシングの意味
worker.springboot.type=lb
# 同一なsessionIDの場合、一つのtomcatだけに継続的に管理する必要がある場合。
worker.springboot.sticky_session=true
# ロードバランシングのリスト
worker.springboot.balance_workers=worker1,worker2	
# 1番目のロードバランシングのTomcat
worker.worker1.type=ajp13
# ホスト名
worker.worker1.host=localhost
# ajpポート
worker.worker1.port=9091
# 処理割り当て比率、つまり、2番目に1という設定したので、1:1比率でロードバランシングになる。
worker.worker1.lbfactor=1	
# 2番目のロードバランシングのTomcat
worker.worker2.type=ajp13
# ホスト名
worker.worker2.host=localhost
# ajpポート
worker.worker2.port=9092
# 不可分散比率
worker.worker2.lbfactor=1

上みたいにworks.propertiesにロードバランシング設定をします。

これからapacheを実行してブラウザから接続しましょう。

そうするとlocalhostに接続するたびに結果が9091になる時もあるし、9092になる場合もあります。