JavaScriptのシュールレアリズム。 NodeJS開発のヒント

こんにちは、Habra！



半年前、私は「本を書けますか？」と思って、それを書きました。







すべてのドキュメントが実行され、ページがレイアウトされ、印刷実行が印刷されます。 キックスターターにお金を頼むことも、何かを買うことを申し出ることもありませんが、代わりに、広報のためのNodeJSの開発のヒントに興味を持ち、本に注目してください。

ヒント1. SQLクエリは、フォーマットを維持するのが最適です。

SQLクエリをフォーマットして保存することをお勧めします。 この場合のコードは、読み取りと編集がはるかに簡単です。 なぜなら 通常、SQLクエリは非常に長く、複数の行に分割する方が適切です。JavaScriptの行は配列で最適に見えます。



宛先：

var query = "SELECT g.id, g.title, g.description, g.link, g.icon, t.id as tag_id, c.title as comment_title FROM games AS g LEFT JOIN tags AS t ON t.game_id = g.id LEFT JOIN comments AS c ON c.game_id = g.id WHERE g.id = $1";
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

後：

 var query = [ "SELECT ", " g.id, g.title, g.description, g.link, g.icon, ", " t.id as tag_id, c.title as comment_title ", " FROM games AS g ", " LEFT JOIN tags AS t ON t.game_id = g.id ", " LEFT JOIN comments AS c ON c.game_id = g.id ", " WHERE ", " g.id = $1" ];
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

2番目のケースでは、読者にとってリクエストがはるかに明確であることに同意します。 さらに、データベースへのリクエストの前にコンソールにクエリを出力すると、console.dir（）でスローされる配列は、console.log（）でスローされる文字列よりもはるかに明確になります。

ヒント2.さまざまなコンポーネントのAPIが任意の形式を入力として受け入れると、作業が楽になります。

データベースのクライアントを作成し、特定のSQLクエリを実行するとします。 入力では、文字列とパラメーターが必要です。 なぜなら 長いクエリを配列に格納することにした最後のヒントを使用して、各クエリで文字列に変換することを忘れたいと思います。



宛先：

 dataBase(query.join(""), parameters, callback);
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

後：

 dataBase(query, parameters, callback);
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

データベースクエリ関数（この場合はdataBase）が、リクエストが送信された形式で自身をチェックし、それが配列の場合、それ自体を結合するときに、コードはより単純になります（）。

ヒント3.コンソールに色を付けて出力をフォーマットする

NodeJSの借方プログラムは難しいため、 「ブレークポイント」などのすべてのチップを備えた標準開発者コンソールは非常に不足しています。 すべてのデータはコンソールに書き込まれるので、わかりやすくしたいと思います。 ノードがサーバー上のどこかで、複数のインスタンスで、さらには各インスタンスで複数の異なるサービスでさえもハングし、SSH経由でのみアクセスできる場合、コンソールは本当にあなたを苦しめます。



NodeJSで「Hello world！」という形式の文字列をコンソールに出力する場合、ANSI制御文字を使用すると、さまざまな色でペイントされます。 ANSI制御文字の使用例：







このようなハッキングを覚えないようにするには、colorsモジュールを接続して、次の構文を使用できます。

 console.log("Error! Parameter ID not found.".red);
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

文字列は赤で表示されます。 このモジュールを使用して開発する場合、コンソール内のメッセージをさまざまな色に色付けできます。

• 赤（エラー）。
• 黄色（警告）。
• 緑（すべて順調）。
• 灰色 エラーをキャッチするまで注意を払えないパラメーター（クエリパラメーターなど）を表示できます。

色を強調表示する前のコンソール（すばやく表示する場合、情報は難なく知覚されます）：







色の強調表示後のコンソール（すばやく表示すると、情報が非常にすばやく認識されます）：







色付きのコンソールのおかげで、サーバーのステータスを監視するのがはるかに簡単になります。 さらに、1つのインスタンスに異なるプロセスで動作する複数のサービスがある場合、コンソールへの出力用にモジュールに個別のメソッドを記述する必要もあります。 例：

 var book = { console: function(message, color) { console.log(("Book API: " + (message || ""))[(color || white")]); } }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

コンソール内のすべてのメッセージがそれらを送信するモジュールによって署名されている場合、特定のモジュールを選択できるだけでなく、重大な状況のバグのソースを即座に見つけることもできます。 テキストの書式設定により、情報の認識も簡素化されます。







したがって、コンソールのすべての情報が署名され、特定のモジュールで発生するイベントを簡単に理解できます。 繰り返しになりますが、特定のシステムに障害が発生して緊急に修正する必要があり、ログを読む時間がない場合、ストレスの多い状況で色の強調表示が役立ちます（実稼働環境をデバッグすることはお勧めしません。 私のプロジェクトでは、すべてのインスタンスに自動的に署名するだけでなく、文字列だけでなく配列やオブジェクトにも色を付けることができるように、コンソールモジュールを書き直すことにしました。 したがって、モジュールを接続するときに、メッセージに署名するパッケージの名前を渡します。 新しいコンソールモジュールの使用例：

 var console = require("./my_console")("Scoring SDK"); console.green("Request for DataBase."); console.grey([ "SELECT *", " FROM \"ScoringSDK__game_list\"", " WHERE key = $1;" ]);
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

コンソールへのデータ出力の例：

ヒント4.すべてのAPIをtry / catchでラップする

エクスプレスフレームワークを使用しています。 標準ルーターオブジェクトにはtry / catchラッパーがないことがわかったとき、私は驚きました。 例：

1. 曲線モジュールを書きました
2. 誰かがURLでそれを引っ張った
3. サーバーがクラッシュしました
4. WTF！？

したがって、常に外部モジュールAPIをtry / catchでラップします。 何かがうまくいかなくても、少なくともカーブモジュールがシステム全体を圧倒することはありません。 テンプレート「選択」を使用したクライアント上の同じ状況（「リスナーとパブリッシャー」とも呼ばれます）。 例：

• モジュールAが投稿を投稿しました。
• モジュールBとCはそれを聞いて応答するはずです。
• システムは、加入者をループでループし始めます。
• モジュールBはエラーでクラッシュします。
• サイクルは中断し、モジュールBのコールバック関数は呼び出されません。

try / catch検索を実行する方がはるかに優れており、モジュールBが実際にエラーでクラッシュした場合、少なくともシステムを強制終了することはなく、モジュールCはイベントを聞いた後にジョブを実行します。



なぜなら APIモジュールを作成するとき、プライベートメソッドとパブリックメソッドを何度も分離する必要があり、すべてのパブリックメソッドをtry / catchでラップした後、このビジネスを自動化することを決定し、API自動生成用の小さなモジュールを作成しました。 たとえば、フォームのオブジェクトをスローします：

 var a = { _b: function() { ... }, _c: function() { ... }, d: function() { ... } }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

メソッドの命名から、最初の2つはプライベートで、最後のメソッドはパブリックであることは明らかです。 モジュールは、後者を呼び出すラッパーを作成します。形式は次のとおりです。

 var api = { d: function() { try { return ad(); } catch(e) { return false; } } };
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

したがって、すべてのモジュールのAPIのラッパーを生成し始めました。エラーが発生した場合、それはそれ以上渡されませんでした。 これにより、コードがより安定しました 本番環境にマージされた個々の開発者のエラーにより、サーバーのすべての機能が削除されることはなくなりました。



API生成の例：

 var a = { _b: function() { ... }, _c: function() { ... }, d: function() { ... } } var api = api.create(a); api.d(); //  
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

ヒント5.構成で要求を収集する

すべてのWeb開発者は、サーバー上のデータベースを操作するために小さなAPIを必要とする脂っこいクライアントがいる状況にあったと思います。 いくつかの読み取り要求、いくつかの書き込み要求、および情報を削除するためのいくつかの要求。 通常、このようなサーバーにはロジックはなく、クエリのコレクションにすぎません。



そのような操作のラッパーを毎回作成しないように、すべてのリクエストをJSONで作成し、このJSONを操作するためのAPIを提供する小さなモジュールとしてサーバーを設計することにしました。



Expressでのこのようなモジュールの例：

 var fastQuery = require("./fastQuery"), API = fastQuery({ scoring: { get: { query: "SELECT * FROM score LIMIT $1, $2;" parameters: [ "limit", "offset" ] }, set: { query: "INSERT INTO score (user_id, score, date) VALUES ...", parameters: [ "id", "score" ] } }, profile: { get: { query: "SELECT * FROM users WHERE id = $1;", parameters: [ "id" ] } } });
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

モジュールがJSONを介して実行され、クエリとパラメーターのプロパティを持つオブジェクトを検索することを既に推測しているでしょう。 そのようなオブジェクトが見つかった場合、彼はそれらのための関数を作成し、パラメーターをチェックし、リクエストとともにデータベースにアクセスし、結果をクライアントに送信します。 出力では、次のAPIを取得します。

 API.scoring.get(); API.scoring.set(); API.profile.get();
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

そして、これをルーターオブジェクトにバインドします。

 exports.initRoutes = function (app) { app.get("/scoring/get", API.scoring.get); app.put("/scoring/set", API.scoring.set); app.get("/profile/get", API.profile.get); }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

この目的のためにフレームワークを実行しません。 サーバー上のテクノロジースタックは企業によって異なります。 このようなオブジェクトを使用するには、いずれにしても、リクエストを処理してデータベースを操作するために、何かの上に小さなバインディングを記述する必要があります。 さらに、おそらくこれらの行を読んだ時点で、このタスクのための既製のフレームワークがすでにいくつかあるでしょう。



さらに2人のサーバー開発者がいると想像してください。 1つはPHPで記述し、2つ目はJavaで記述します。 データベースクエリのリストを使用して、そのようなJSONだけにすべてのサーバーロジックを制限している場合は、同様のAPIを別のマシンだけでなく、完全に異なる言語でも即座に転送/デプロイできます（クライアントとの通信が標準化されていて、 REST APIを介して通信します）。

ヒント6. configsですべてを取り出す

なぜなら 私は設定を書きたいのですが、システムに標準設定、特定のケースの設定、特定の時点で発生した設定があるという状況が繰り返し発生しました。 異なるJSONオブジェクトを混在させなければなりませんでした。 これらの目的のために別のモジュールを割り当てることにしましたが、同時にファイルからJSONオブジェクトを取得する機能を追加しました。 設定を別のjsonファイルに保存することも非常に便利です。 したがって、何かの設定を行う必要があるので、次のように書きます。

 var data = config.get("config.json", "save.json", { name: "Petr", age: 12 });
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

ご想像のとおり、モジュールは渡された引数を反復処理します。 これが行の場合-オブジェクトの場合は、ファイルを開いて設定を読み取ろうとします-その後、すぐに前のファイルと交差させようとします。



上記の例では、最初にconfig.jsonファイルからいくつかの標準設定を取得し、save.jsonファイルから保存された設定をそれらに適用してから、特定の時間に関連する設定を追加します。 出力では、3つのJSONオブジェクトが混在しています。 モジュールに渡される引数の数は任意です。 たとえば、デフォルト設定のみを要求できます。

 var data = config.get("config.json");
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

ヒント7. CEO向けのファイルとソーシャルリンクモジュールの操作

NodeJSで気に入っている主な機能の1つは、JavaScriptでファイルを操作し、パーサーを作成できることです。 同時に、NodeJS APIは問題を解決するための多くのメソッドとメソッドを提供しますが、実際にはそれほど必要ありません。 パーサーでの半年間のアクティブな作業では、ファイルの読み取りと書き込みの2つのコマンドのみを使用しました。 さらに、コールバック関数や非同期のさまざまな問題に悩まされないように、私は常に同期モードでファイルを操作しました。 そのため、ファイルを操作するための小さなモジュールがあり、そのAPIはlocalStorageに非常に似ていました。

 var file = requery("./utils.file.js"), //   text = file.get("text.txt); //     file.set("text.txt", "Hello world!"); //    
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

ファイルを操作するためのこのモジュールに基づいて、他のモジュールが表示され始めました。 たとえば、CEO用のモジュール。 以前の記事の1つで、CEOに関連するさまざまなメタタグが非常に多数あることを既に書きました。 HTMLアプリケーション用のアセンブリシステムの記述を開始したとき、CEOに特に注意を払いました。



一番下の行は、サイト/アプリケーション/ゲームの説明と解析用のHTMLファイル自体を含む小さなテキストファイルがあることです。 Social Linkモジュールは、HTMLファイル内でCEOに関連するすべてのメタタグを見つけて記入する必要があります。 外部モジュールAPIは、ファイルからのテキストを入力として予期します。 これは、アセンブリシステムに接続し、毎回余分な読み取り/書き込みを行うことなく、複数のファイルのテキストを実行できるようにするために行われます。



たとえば、モジュールの前に：

 <title></title> <meta property="og:title" content=""/> <meta name="twitter:title" content=""/>
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

モジュールの後：

 <title> </title> <meta property="og:title" content=" "/> <meta name="twitter:title" content=" "/>
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

CEOのすべてのメタタグのリストと説明だけでなく、本http://bakhirev.biz/で見ることができます。

ヒント8.コールバックがなければ、人生は楽になります。

多くの開発者は、NodeJSでサーバーを作成するときに、コールバックの無限のチェーンについて不満を言っています。 実際、あなたは常にそれらを書くことを義務付けられているわけではなく、そのようなチェーンが最小限になるようなアーキテクチャをしばしば構築することができます。 小さなタスクを検討してください。



チャレンジ：

サーバーAからサーバーBにファイルを転送し、データベースから情報を取得し、この情報を更新して、サーバーBにデータを送信します。



解決策：

これは、ソート/処理タスクを解決するために繰り返し実行しなければならないかなり日常的な手順です。 通常、開発者はnextFile（）メソッドを使用してループとコールバック関数を作成します。 次の反復でnextFile（）を呼び出すと、コールバックメカニズムが最初から開始され、次のファイルを処理します。 原則として、一度に1つのファイルのみを処理し、手順が正常に完了したら、次のファイルの処理に進む必要があります。 ネストを簡単にするために、次のフォームのコードが役立ちます。

 var locked = false, index = 0, timer = setInterval(function() { if(locked) return; locked = true; nextFile(index++); }, 1000);
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

ここで、ファイルの処理を1秒間に開始しようとします。 プログラムが解放されると、lockedがfalseに設定され、処理のために次のファイルを実行できます。 このような構造は、ネストの削減、時間の経過による負荷の分散（次の処理の反復が1秒に1回しか開始されないため）、およびエンドレスコールバックから少なくとも少しクロールするのに役立ちます。



合計

モジュールを含むファイルは、 http ： //bakhirev.biz/_node.zipからダウンロードできます（現在午前2時で、GitHubを処理してコードを人間の形にするのが面倒です）。

本はこちらです： http : //bakhirev.biz/

ここでPDFのハブロ効果の場合。



上記のヒントが気に入った場合は、すぐに別の本に関する本であることを警告したいと思います。 そして最後に、それを疑うことなく自分自身でかけがえのない貢献をしたさまざまな賢い人々のリストがあります。