BayServer

BayServerをインストールする

動作環境

BatServer for JavaJDK1.8以降、OpenJDKも可
BayServer for RubyRuby 2.7.6以降
BayServer for PythonPython 3.7以降
BayServer for PHPPHP 7.4以降
BayServer for TypeScriptnode v16.19.0以降

ここで示したバージョンは、動作確認が取れているバージョンです。これ以前のバージョンでも動くかもしれませんが、サポートされません。

ダウンロード版とパッケージ版

BayServerにはダウンロード版とパッケージ版が存在します。各言語がどの方式をサポートしてるかは以下を参照してください。なお、パッケージ版の提供は2.2.0以降になります。

ダウンロード版パッケージ版
BayServer for Java○○
BayServer for Ruby○○
BayServer for Python○○
BayServer for PHP○○
BayServer for TypeScript○○

ダウンロード版のインストール

ダウンロード版に関しては、どの言語の版でもインストール方法は同じです。（異なる部分があればその都度明記します）

ダウンロード

こちらからダウンロードします。

ダウンロードしたファイルを展開します。

Java版の場合

jar xf BayServer_Java-2.0.0.jar

Ruby版/Python版/PHP版/TypeScript版の場合

tar zxf BayServer_Ruby-2.0.0.tgz

するとディレクトリが作成され、そのディレクトリにBayServer本体がインストールされます。このディレクトリを「BayServerホーム」と呼びます。

起動

BayServerホームに移動します

cd BayServer_Java-2.0.0

binディレクトリを覗くと起動スクリプトが存在するのが確認できます。

ls bin
bayserver.bat  bayserver.sh  bootstrap.bat  bootstrap.jar

Unix系OSの場合は、起動スクリプトに実行権限を付与します

chmod +x bin/bayserver.sh

起動スクリプトを実行します

Unix系OSの場合

bin/bayserver.sh -start

Windowsの場合

bin\bayserver -start

-startオプションは省略可能です。

なお、-daemonオプションを付けることで、デーモンモード、すなわちコンソールから切り離して実行することができます。(Windowsの場合別ウィンドウが開きます)

bin/bayserver.sh -start -daemon

デーモンモードではコンソールにログは出力されません。ログを見たい場合は、設計ファイルにredirectFileパラメータを設定し、ファイルにログを出力させます。

動作確認

BayServerはデフォルトでは2020番ポートで待ち受けます。ブラウザで以下のいずれかのURLを叩いてください。

http://localhost:2020/
https://localhost:2024/

コンテンツが表示されれば起動成功です。

BayServerの終了

起動したターミナルであれば Ctrl-C で終了できます。

別のターミナルから終了する場合は、

bin/bayserver.sh -stop

で終了します

パッケージ版のインストール

Mavenを用いてBayServer for Javaをインストールする

BayServerホームの作成

BayServerのコンテンツなどを管理するディレクトリ(BayServerホーム)を作成します。ここではbhomeとします。

mkdir bhome
cd bhome

pom.xmlの作成

次のようなpom.xmlをBayServerホームに作成します。BayServerのバージョンは最新版を指定してください。

<?xml version="1.0" encoding="UTF-8"?>

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">

  <modelVersion>4.0.0</modelVersion>
  <groupId>testGroup</groupId>
  <artifactId>testArtifact</artifactId>
  <version>1.0</version>
  <dependencies>
    <dependency>
      <groupId>yokohama.baykit</groupId>
      <artifactId>bayserver</artifactId>
      <version>2.2.0</version>
      <scope>runtime</scope>
    </dependency>
    <dependency>
      <groupId>javax.servlet</groupId>
      <artifactId>javax.servlet-api</artifactId>
      <version>4.0.1</version>
      <scope>compile</scope>
    </dependency>
 </dependencies>
<build>
    <plugins>
        <plugin>
            <groupId>org.codehaus.mojo</groupId>
            <artifactId>exec-maven-plugin</artifactId>
            <version>3.0.0</version>
            <executions>
                <execution>
                    <goals>
                        <goal>java</goal>
                    </goals>
                </execution>
            </executions>
            <configuration>
                <mainClass>yokohama.baykit.bayserver.boot.Boot</mainClass>
            </configuration>
        </plugin>
    </plugins>
</build>

</project>

パッケージのインストール

以下のコマンドを入力し、mvnを使用してBayServer for Javaをインストールします。

mvn install

BayServerホームの初期化

以下のコマンドを入力してBayServerホームを初期化します。

mvn exec:java -Dexec.args="-init"

これにより、設定ファイルやドキュメントなどのファイルが生成されます。

BayServerの起動

以下のコマンドを入力してBayServerを起動します。

mvn exec:java

2020番でHTTPポートが、2024番でHTTPSポートが開きます。

BayServerの終了

起動したターミナルであれば Ctrl-C で終了できます。

別のターミナルから終了する場合は、

mvn exec:java -Dexec.args="-stop"

で終了します

Gemを用いてBayServer for Rubyをインストールする

パッケージのインストール

以下のコマンドを入力し、gemを使用してBayServer for Rubyをインストールします。

gem install bayserver

BayServerホームの作成と初期化

BayServerのコンテンツなどを管理するディレクトリ(BayServerホーム)を作成します。ここではbhomeとします。

mkdir bhome
cd bhome

以下のコマンドを入力してディレクトリを初期化します。

bayserver_rb -init

これにより、設定ファイルやドキュメントなどのファイルが生成されます。

BayServerの起動

以下のコマンドを入力してBayServerを起動します。

bayserver_rb -start

2020番でHTTPポートが、2024番でHTTPSポートが開きます。

BayServerの終了

起動したターミナルであれば Ctrl-C で終了できます。

別のターミナルから終了する場合は、

bayserver_rb -stop

で終了します

pipを用いてBayServer for Pythonをインストールする

パッケージのインストール

以下のコマンドを入力し、pipを使用してBayServer for Pythonをインストールします。

pip install bayserver

BayServerホームの作成と初期化

BayServerのコンテンツなどを管理するディレクトリ(BayServerホーム)を作成します。ここではbhomeとします。

mkdir bhome
cd bhome

以下のコマンドを入力してディレクトリを初期化します。

bayserver_py -init

これにより、設定ファイルやドキュメントなどのファイルが生成されます。

BayServerの起動

以下のコマンドを入力してBayServerを起動します。

bayserver_py -start

2020番でHTTPポートが、2024番でHTTPSポートが開きます。

BayServerの終了

起動したターミナルであれば Ctrl-C で終了できます。

別のターミナルから終了する場合は、

bayserver_py -stop

で終了します

composerを用いてBayServer for PHPインストールする

BayServerホームの作成

BayServerのコンテンツなどを管理するディレクトリ(BayServerホーム)を作成します。ここではbhomeとします。

mkdir bhome
cd bhome

パッケージのインストール

以下のコマンドを入力し、composerを使用してBayServer for PHPをインストールします。

composer require baykit/bayserver

BayServerホームの初期化

BayServerの起動スクリプトはvendor/binにbayserver_phpになります。以下のコマンドを入力してディレクトリを初期化します。

vendor/bin/bayserver_php -init

これにより、設定ファイルやドキュメントなどのファイルが生成されます。

BayServerの起動

以下のコマンドを入力してBayServerを起動します。

vendor/bin/bayserver_php -start

2020番でHTTPポートが、2024番でHTTPSポートが開きます。

BayServerの終了

起動したターミナルであれば Ctrl-C で終了できます。

別のターミナルから終了する場合は、

vendor/bin/bayserver_php -stop

npmを用いてBayServer for TypeScriptをインストールする

パッケージのインストール

Nodeプロジェクトのディレクトリを作成します。ここではbhomeとします。

mkdir bhome 
cd bhome

以降、作業はプロジェクトルート上で行ってください。

以下のように、BayServerパッケージをインストールします。以下はBayServer2.2.Xの最新版をインストールする例です。

npm install bayserver

BayServerが使用可能になるよう、パッケージルートに必要なファイルを生成します。

BayServerホームの初期化

npx bayserver -init

これにより、設定ファイルやドキュメントなどのファイルが生成されます。

BayServerの起動

以下のコマンドを入力してBayServerを起動します。

npx bayserver -start

2020番でHTTPポートが、2024番でHTTPSポートが開きます。

BayServerの終了

起動したターミナルであれば Ctrl-C で終了できます。

別のターミナルから終了する場合は、

npx bayserver -stop

で終了します。

ダウンロード版とパッケージ版の違い

ダウンロード版とパッケージ版は、インストールしてしまえば使い方はほぼ一緒です。ただし、BayServer Homeの扱いが若干異なります（結果的にはほぼ同じですが）。

ダウンロード版の場合、Bayserver Homeはダウンロードしたアーカイブを展開した時に生成されるディレクトリになります。パッケージ版の場合は、カレントディレクトリがBayServer Homeになります。なお、BSERV_HOME環境変数または-homeオプションで指定した場合はそちらがBayServer Homeになります。

また、パッケージ版のBayServerは-deamonオプションは使用できません。

Twitterでフォローしよう

おすすめの記事