Node.js において、JSONをパースして抽出した文字列が関数の外で使えない

Question

前提・実現したいこと

SLACKのユーザIDから表示名(display_name)を得るスクリプトをサーバ上の Node.js で実現しようと思いました。
そこで Windows 版の node.js v10.15.1 を使って、サーバから取得した JSONをパースして、必要な値をget_user_name関数の外側で使いたいと考えました。

発生している問題・エラーメッセージ

ログ(result_txtの値)が出力されない（正確には、改行が1行出力される）。

該当のソースコード

var get_user_name = require('request');
global.result_txt="";

const url1 = 'https://slack.com/api/users.info?token=xoxp-HIMITSU-HIMITSU-HIMITSU&user=';
const url2 = '&pretty=1';

user = 'X1X1X1XX1';

var options = {
url: url1+user+url2, 
method: 'GET',
json: true
}

get_user_name(options,function (error, respinse,body ){
	result_txt=(body.user.profile.display_name).toString;
})

console.log(result_txt);

試したこと

get_user_name(options,function (error, respinse,body ){
	result_txt=(body.user.profile.display_name).toString;
　　　　console.log(result_txt);
})

とすると、正しく表示ユーザがログに取得できますが、関数外で使いたいので、

get_user_name(options,function (error, respinse,body ){
	result_txt=(body.user.profile.display_name).toString;
})
console.log(result_txt);

と書いても動く形に持っていきたいです。単純な発想で、Global変数を使えば解決できると思ったのですが、どうやら、関数の中の変数と外の変数で、型が違うのでこの問題が起きているような気がします。

補足情報（FW/ツールのバージョンなど）

ここにより詳細な情報を記載してください。

Answer 1

Node.js名物の非同期処理の洗礼ですね。
「非同期処理」や「コールバック地獄」などのワードでググってお勉強してください。

---

ブラウザに搭載されているJavaScriptと共通の話ですが、
JSはシングルスレッドで動作します。
JSの実行中はブラウザの応答が完全に止る仕様であるためスリープみたいなことは実現不可能です。
とにかくさっさと実行して終了させる必要がある。

しかし、そこで壁になるのがI/O処理です。
ファイルの読み書き・ネットワークのリクエスト……といった事は処理にいくら時間がかかるのか読めない部分があります。
Ajaxの為にHTTPリクエスト投げた瞬間ブラウザが固まるとかユーザビリティ糞じゃん。

そこで、JSはイベント駆動という考え方をします。
ブラウザが用意している「イベント置き場」というのがありまして、
そこに「イベント完了条件」と「実行したい内容の関数」をセットで登録します。

ブラウザ内では無数のイベントが飛び交っています。
「マウスカーソルが動いた時」「HTTP通信が完了した時」「マウスで何かの要素をクリックした時」
ブラウザは絶えずイベント置き場を巡回しており、完了したイベントが見つかり次第対応する関数を実行という事を行っています。

質問文のコードで解説します。

get_user_name(options,function (error, respinse,body ){
    result_txt=(body.user.profile.display_name).toString;
})
console.log(result_txt);

get_user_name関数を発火させた時、
第二引数で「終わったら実行して欲しい関数」をコールバックとして渡しています。
get_user_nameの中身はrequestによりHTTPリクエストを発射しているはずなので、
待ちぼうけするには長いので、そのコールバック関数はそのまんまイベント完了時に実行される関数に登録します。
そのまま「イベント登録終わったから次いこう」と関数の処理が終わります。

イベントの巡回＆コールバック関数を取り出して実行されるタイミングは、
JSの実行が全て完了して暇になってからです。

なので、例えローカルマシン内で次の行が実行される前に結果を受け取ったとしても、
質問文のコードでは先にconsole.log(result_txt);が実行されます。
終わって暇になり、イベントの巡回を待ってからコールバック関数が実行されてresult_txt変数の中身が書き換わります。

この辺が非同期処理の仕組みになっています。
解決法は単純、「コールバック関数の中身で後続のやりたい処理を全部書け」
何の解決にもなりませんが、こうすれば使えます。

get_user_name(options,function (error, respinse,body ){
    result_txt=(body.user.profile.display_name).toString;
    console.log(result_txt);
})

「後続のやりたい処理を全部書け」って中々クレイジーですね。
非同期処理でやりたい事が増えれば増える程ネストが深くなり糞みたいなコードになります。

これを「コールバック地獄」と呼びます。

---

何か対策はないの？

ベストプラクティスを紹介します。

まずはPromiseを覚えて使いましょう。
ある程度使いこなせるようになったらasync/awaitという構文を覚えましょう。

async/awaitはPromiseを良い感じに扱う糖衣構文で、
ここまで学習が進めば非同期処理は全く怖くありません。

実は今回使っているrequestモジュールですが、これのPromise版があります。
調査して使ってみてください。

request-promiseを使ったHTTPクライアントを作る - Qiita

Comments

[nori3]

丁寧な回答まことにありがとうございました。Promiseは手元の本の項目にあったのですが、難しそうと思って読み飛ばしてしまいました。
私が非同期処理の根本を理解していなかったことが分かりましたので、教えていただいたサイトやキーワードを中心に勉強してみたいと思います。手続き型プログラミング言語しか触っていなかった学生時代SQLに出会ったときと同様のショックがありました。
とりあえず今回は実装を急ぐ必要があったのでコールバックに後続処理を追加し、想定の結果を得ることが出来ました。重ねて御礼申し上げます。