Node.js

Node.js と API

　ブラウザ上で動作する JavaScript には標準で DOM を含んだ Web API と呼ばれる API が連携されています。
　一方、ブラウザに依らない Node.js では DOM、ファイル操作やネットワーク通信機能といった API は既存で含まれておらず、インクルード（ require() ）することで機能を拡充します。

　本来の JavaScript の言語仕様に、 DOM や Node.js で利用できるファイル操作やネットワーク通信機能は含まれていません。（たまにそのようなことが記載された内容を見かけます。）
　Node.js では、DOM やファイル操作やネットワーク通信機能は API（Application Programming Interface）として JavaScript にインクルードする形をとります。

　例えば以下のようなコアモジュールとして API が用意されています。

　必要なファイル操作やネットワーク通信といった API はモジュールとして用意されており、reauire() によってインクルードします。

const fs = require( 'fs' );

　上記の例はファイルに関するモジュールをインクルードする例です。

　JavaScript で利用できるモジュールには、既に用意されている上記のようなコアモジュールがあります。
　また、作成することもでき、サードパーティによるものあります。

インストール

　まずは、Node.js の Ubuntu におけるインストール方法です。

　先にインストール済みのパッケージをアップデートしておきます。

$ sudo apt update

　インストール済みかは Node.js のバージョンによって確認することができます。

$ nodejs
コマンド 'nodejs' が見つかりません。次の方法でインストールできます:
sudo apt install nodejs

　以下のように Node.js をインストールします。パッケージ名はnodejsです。

$ sudo apt install nodejs

　パッケージ名を検索するには seach オプションを利用します。

$ sudo apt search nodejs

　Node.js では モジュール管理を npm によって行います。npm もインストールしておきましょう。

$ sudo apt install npm

js ファイルの実行

　Node.js において JavaScript ファイル（ 拡張子 .js ファイル ）を実行するには node コマンドを使用します。

$ node example.js

環境変数の取得

　Node.js のプログラム上から OS の環境変数を取得するには process.env を使用します。

　例えば以下のコードを実行するとすべての環境変数を取得することができます。

console.log( process.env );

引数の取得

　node コマンドで .js ファイルを実行するときに引数を渡したいときがあります。
　コマンドラインの引数を取得するには process.argv を使用します。

// 例えば　node example.js a b
console.log( process.argv );

// [a,b,c] と出力されます。

　process は、Node.js より OS のプロセスを管理するためのものです。process は require() する必要はありません。

コアモジュール

　Node.js のコアモジュールは Node.js に用意された既存のモジュールです。ファイル操作やネットワーク通信といった OS 依存の API を利用するにはコアモジュール使用します。

　コアモジュールを読み込みには require() を使用します。
　引数に上記のコアモジュール名を指定します。コアモジュール名は文字列としてシングルコーテーション' 'またはダブルコーテーション" "で囲みます。

require( 'fs' );

　モジュールは自作することもできます。*.js といった js というファイル拡張子が付いたファイルとして作成します。
　サードパティから提供されるモジュールは npm モジュールとしてnode_modulesディレクトリ以下に置きます。

モジュールの作成

　モジュールの作成は以下のようにします。

/* -- 以下を example_module.js というファイルで作成 -- */

const abc = "a";

function exec_example(){
	return true;
}

class example_module(){
	constructor( v ){
	this._val = val;
  }

  get value(){
	return this._val;
  }

  set value( v ){
	this._val = v;
  }
}

module.exports = abc;
module.exports = exec_example();
module.exports = example_module();

　モジュールを読み込むためには require() メソッドでファイルパスまたはパッケージ名を指定します。

　例えば上記の例 example_module.js をモジュールとして読み込むためには以下のような構文を使用します。

const exec_example_module = require( './example_module.js' );

　require() メソッドの引数にはファイルパス、コアモジュール名、npm によるパッケージ名が指定できます。

　import 文でモジュールを読み込むこともできます。

import * from './example_module.js';

npm モジュール

　サードパーティーによるモジュールの多くは npm モジュールとして扱います。サードパーティーによるモジュールはnode_modulesディレクトリ以下に置きます。

　npm モジュールを読み込みには require() を使用します。
　引数に上記の npm モジュール名を指定します。
　npm モジュールはnode_modulesディレクトリ以下にあることが前提で、モジュール名の指定だけで./や../といったディレクトリ指定は必要ありません。モジュール名は文字列としてシングルコーテーション' 'またはダブルコーテーション" "で囲みます。

require( 'fs' );

　npm モジュールを require() で指定すると、以下のディレクトリの順に指定されたファイルを探します。

• /home/*/test_project/node_modules/
• /home/*/node_modules/
• /home/node_modules/
• /node_modules/

　自作したモジュールはnode_modules以下においてはいけません。このディレクトリ以下のモジュールは自動で管理されているため改変されたり削除される可能性があります。

コアモジュールの利用

　この節ではモジュールの利用方法について解説します。ファイル操作、ネットワーク通信（ HTTP サーバーの構築 ）、プロセス管理について取り上げています。

const fs = require( 'fs' );

const fs = require( 'fs' );

fs.readdir( pth.join( __dirname ), function( error, files ){
	if( error ) return console.error( 'directry read error.' );

	for (const file of files) {
		console.log( file );
	}
} );

const fs = require( 'fs' );

fs.readFile( 'example.txt', { encoding: 'utf-8' }, function( error, data ){
	if( error ) return console.error( 'file read error.' );
} );

const fs = require( 'fs' );

fs.readFile( __dirname + 'example.txt', { encoding: 'utf-8' }, function( error, data ){
	if( error ) return console.error( 'file read error.' );
} );

const fs = require( 'fs' );
const pth = require( 'path' );

fs.readFile( pth.join( __dirname, 'example.txt' ), { encoding: 'utf-8' }, function( error, data ){
	if( error ) return console.error( 'file read error.' );
} );

const fs = require( 'fs' );
const pth = require( 'path' );

fs.writeFile( pth.join( __dirname, 'example.txt' ), 'ファイルの作成テスト\n', function( error ){
	if( error ) return console.error( 'file write error.' );
} );

const fs = require( 'fs' );
const pth = require( 'path' );

try{
	fs.writeFile( pth.join( __dirname, 'example.txt' ), 'ファイルの作成テスト\n' );
} catch( error ) {
	console.error( 'file write error.' );
}

const fs = require( 'fs' );

const rstream = fs.createReadStream( 'example.txt', { encoding:'utf8' } );
rstream.on( 'data', function( data ){
	console.log( data );
} );
rstream.on( 'end', function( data ){
	console.log( '>> end of data' );
} );

const fs = require( 'fs' );

const rstream = fs.createReadStream( 'example.txt' );
const wstream = fs.createWriteStream( 'new.txt' );

rstream.pipe( wstream );

const http = require( 'http' );

const svr = fs.createServer( function( request, response ){
	console.log( request.url );
	console.log( request.method );
	response.end( 'request is arrived.' );
} );

const port = 8080;
svr.listen( port, function(){
		console.log( 'Server is started.' );
} );

process.exit(1);

console.log( process.cwd() );

process.chdir( __dirname );

// カレントディレクトリの取得
console.log( process.cwd() );

　Node.js については公式ドキュメントがあります。公式ドキュメントは https://nodejs.org/ja/docs から参照してください。