NodeJSモジュールで定数をどのように共有しますか？

現在私はこれをやっています：

foo.js

const FOO = 5;

module.exports = {
    FOO: FOO
};

そしてそれを使ってbar.js：

var foo = require('foo');
foo.FOO; // 5

これを行うより良い方法はありますか？exportsオブジェクトで定数を宣言するのは面倒です。

で明示的にグローバルスコープにエクスポートできglobal.FOO = 5ます。次に、ファイルを要求するだけでよく、戻り値を保存する必要もありません。

しかし、実際にはそうすべきではありません。物事を適切にカプセル化しておくことは良いことです。あなたはすでに正しい考えを持っているので、今していることを続けてください。

私の意見では、利用するObject.freezeことでDRYerとより宣言的なスタイルが可能になります。私の好みのパターンは：

./lib/constants.js

module.exports = Object.freeze({
    MY_CONSTANT: 'some value',
    ANOTHER_CONSTANT: 'another value'
});

./lib/some-module.js

var constants = require('./constants');

console.log(constants.MY_CONSTANT); // 'some value'

constants.MY_CONSTANT = 'some other value';

console.log(constants.MY_CONSTANT); // 'some value'

古いパフォーマンス警告

次の問題は2014年1月のv8で修正され、ほとんどの開発者には関係ありません。

書き込み可能をfalseに設定することとObject.freezeを使用することの両方で、v8でパフォーマンスが大幅に低下することに注意してください-https : //bugs.chromium.org/p/v8/issues/detail? id = 1858およびhttp://jsperf.com / performance-frozen-object

技術的にconstは、ECMAScript仕様の一部ではありません。また、メモした「CommonJS Module」パターンを使用すると、その「定数」の値を変更できます。これは、オブジェクトプロパティにすぎないためです。（同じモジュールを必要とする他のスクリプトへの変更がカスケードされるかどうかはわかりませんが、可能です）

あなたも共有できることを実定数を取得するには、チェックアウトObject.create、Object.definePropertyとObject.defineProperties。を設定した場合writable: false、「定数」の値は変更できません。:)

これは少し冗長です（ただし、少しのJSでも変更できます）が、定数のモジュールに対して一度だけ実行する必要があります。これらのメソッドを使用すると、省略した属性はデフォルトでになりfalseます。（割り当てによってプロパティを定義するのではなく、すべての属性をデフォルトでに設定しますtrue）

だから、仮に、あなただけ設定することができvalue、およびenumerable、除外writableしてconfigurable、彼らがために、デフォルトよ以来false、私は明確にするためにそれらを含めました。

更新 - この非常にユースケースのヘルパー関数を使用して、新しいモジュール（node-constants）を作成しました。

constants.js-良い

Object.defineProperty(exports, "PI", {
    value:        3.14,
    enumerable:   true,
    writable:     false,
    configurable: false
});

constants.js-より良い

function define(name, value) {
    Object.defineProperty(exports, name, {
        value:      value,
        enumerable: true
    });
}

define("PI", 3.14);

script.js

var constants = require("./constants");

console.log(constants.PI); // 3.14
constants.PI = 5;
console.log(constants.PI); // still 3.14

ES6の方法。

foo.jsにエクスポート

const FOO = 'bar';
module.exports = {
  FOO
}

bar.jsにインポート

const {FOO} = require('foo');

Dominicが最適なソリューションを提案しましたが、「const」宣言の1つの機能がまだありません。JSで「const」キーワードを使用して定数を宣言すると、定数の存在は実行時ではなく解析時にチェックされます。したがって、コードの後半で定数の名前のスペルを間違えた場合、node.jsプログラムを起動しようとするとエラーが発生します。これははるかに優れたスペルミスチェックです。

Dominicが提案するように、define（）関数を使用して定数を定義する場合、定数のスペルを間違えてもエラーは発生せず、スペルの間違った定数の値は未定義になります（デバッグの問題が発生する可能性があります）。

しかし、これは私たちが得ることができる最高のことだと思います。

さらに、constans.jsでのDominicの機能の一種の改善を以下に示します。

global.define = function ( name, value, exportsObject )
{
    if ( !exportsObject )
    {
        if ( exports.exportsObject )
            exportsObject = exports.exportsObject;
        else 
            exportsObject = exports;        
    }

    Object.defineProperty( exportsObject, name, {
        'value': value,
        'enumerable': true,
        'writable': false,
    });
}

exports.exportObject = null;

このようにして、他のモジュールでdefine（）関数を使用でき、constants.jsモジュール内と、関数を呼び出したモジュール内の定数の両方で定数を定義できます。モジュール定数の宣言は、（script.jsで）2つの方法で実行できます。

最初：

require( './constants.js' );

define( 'SOME_LOCAL_CONSTANT', "const value 1", this ); // constant in script.js
define( 'SOME_OTHER_LOCAL_CONSTANT', "const value 2", this ); // constant in script.js

define( 'CONSTANT_IN_CONSTANTS_MODULE', "const value x" ); // this is a constant in constants.js module

第二：

constants = require( './constants.js' );

// More convenient for setting a lot of constants inside the module
constants.exportsObject = this;
define( 'SOME_CONSTANT', "const value 1" ); // constant in script.js
define( 'SOME_OTHER_CONSTANT', "const value 2" ); // constant in script.js

また、define（）関数が定数モジュールからのみ呼び出されるようにする場合（グローバルオブジェクトを膨張させないため）、constants.jsで次のように定義します。

exports.define = function ( name, value, exportsObject )

そして、script.jsで次のように使用します。

constants.define( 'SOME_CONSTANT', "const value 1" );

以前のプロジェクト経験から、これは良い方法です：

constants.jsで：

// constants.js

'use strict';

let constants = {
    key1: "value1",
    key2: "value2",
    key3: {
        subkey1: "subvalue1",
        subkey2: "subvalue2"
    }
};

module.exports =
        Object.freeze(constants); // freeze prevents changes by users

main.js（またはapp.jsなど）では、次のように使用します。

// main.js

let constants = require('./constants');

console.log(constants.key1);

console.dir(constants.key3);

constこれでこの年輪を探しているほとんどの人の問題は解決すると思います。不変の定数が本当に必要な場合は、他の答えを調べてください。すべてを整理しておくために、すべての定数をフォルダーに保存し、フォルダー全体を必要とします。

src / main.jsファイル

const constants = require("./consts_folder");

src / consts_folder / index.js

const deal = require("./deal.js")
const note = require("./note.js")


module.exports = {
  deal,
  note
}

Ps。ここdealとnotemain.js上の最初のレベルになります

src / consts_folder / note.js

exports.obj = {
  type: "object",
  description: "I'm a note object"
}

Ps。objmain.jsの第2レベルになります

src / consts_folder / deal.js

exports.str = "I'm a deal string"

Ps。strmain.jsの第2レベルになります

main.jsファイルの最終結果：

console.log(constants.deal); 出力：

{Deal：{str： 'I \' ma deal string '}、

console.log(constants.note); 出力：

note：{obj：{type： 'object'、description： 'I \' ma note object '}}

importおよびexport（インポートを使用するには、2018年の時点でbabelのようなものが必要です）

types.js

export const BLUE = 'BLUE'
export const RED = 'RED'

myApp.js

import * as types from './types.js'

const MyApp = () => {
  let colour = types.RED
}

https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/import

別の方法として、ローカルオブジェクトの「定数」値をグループ化し、このオブジェクトの浅いクローンを返す関数をエクスポートできます。

var constants = { FOO: "foo" }

module.exports = function() {
  return Object.assign({}, constants)
}

次に、誰かがFOOを再割り当てしても、ローカルコピーにのみ影響するため、問題ではありません。

Node.jsはCommonJSパターンを使用しているためmodule.exports、ブラウザーで行うようにグローバル変数を設定するか、グローバル変数を設定することによってのみモジュール間で変数を共有できますが、ウィンドウを使用する代わりにを使用しますglobal.your_var = value;。

定数そのものではなく、匿名のゲッター関数を使用してフリーズしたオブジェクトをエクスポートすることで、これを実現しました。これは、タイプミスの場合に実行時エラーがスローされるため、const名の単純なタイプミスが原因で発生する厄介なバグのリスクを軽減します。以下は、定数にES6シンボルを使用して完全性を保証する完全な例と、ES6矢印関数です。このアプローチに問題があると思われる場合は、フィードバックをいただければ幸いです。

'use strict';
const DIRECTORY = Symbol('the directory of all sheets');
const SHEET = Symbol('an individual sheet');
const COMPOSER = Symbol('the sheet composer');

module.exports = Object.freeze({
  getDirectory: () => DIRECTORY,
  getSheet: () => SHEET,
  getComposer: () => COMPOSER
});

私は、webpackを使用することをお勧めします（webpackを使用していると想定しています）。

定数の定義は、webpack設定ファイルを設定するのと同じくらい簡単です：

var webpack = require('webpack');
module.exports = {
    plugins: [
        new webpack.DefinePlugin({
            'APP_ENV': '"dev"',
            'process.env': {
                'NODE_ENV': '"development"'
            }
        })
    ],    
};

このようにして、ソースの外でそれらを定義すると、それらはすべてのファイルで使用可能になります。

モジュールからGLOBALスペースに侵入するのは良い習慣ではないと思いますが、それを実装するために厳密に必要となるシナリオでは：

Object.defineProperty(global,'MYCONSTANT',{value:'foo',writable:false,configurable:false});

このリソースの影響を考慮する必要があります。これらの定数に適切な名前を付けないと、すでに定義されているグローバル変数を上書きするリスクが現実になります。