javascriptの関数でブロックをしたい

Question

javascriptにおいて、ある関数を排他的に使われるようにして同時に実行
されないうようにしたいのですが、どのようにしたらよいでしょうか？
完全にブロックできれば理想ですが、１秒遅延させられればそれでも十分です。

私が試したのは以下のように「実行中フラグ」みたいなのをセットしてフラグがtrueの場合はsetTimeoutで処理を１秒遅らせるというように試してみたのですが、複数呼び出すと同時に実行されてうまくいきませんでした。。

var is_processing = false;

function somefunc() {
   var wait = 0;
   if (is_processing == true) {
      wait = 1000;
   }
   setTimeout(function() {
       // 処理
       is_processing = true;
　　　 do_something();
       
   }, wait);

   is_processing = false;
}

お手数ですがご教示いただけますと助かります。

Comments

[m.ts10806]

もう少し目的や今回の対応をやることになった経緯など書くと回答も得られやすいかもしれません。別のアプローチも提案があるかもしれませんし

[kei344]

質問文のコードはコードブロックで囲んでいただけませんか？ ```（バッククオート3つ）で囲み、前後に改行をいれるか、コードを選択して「<code>」ボタンを押すとコードブロックになります。

Answer 1

フラグ管理

同期処理である限りは多重実行されませんが、非同期処理でしょうか。

'use strict';
const something = ((executed) => function something () {
  if (executed) {
    throw new Error('something() can not be executed in duplicate');
  }

  executed = true;

  console.log('実行中');

  executed = false;
})(false);

something();

ご存知とは思いますが、変数 executed の処理中フラグは非同期処理が完了したタイミングで変更してください。

タイマー管理

回答いただいたところ恐縮なのですが、Errorを出すとその呼出が失敗してしまうかと思います。。呼び出しに対して実行はしないといけないのですが、同時に実行するのは避けたいというところなのです・・・。

setTimeout なら仕様上、排他処理されます。
実行タイミングは前処理が終わった直後ですが、期待するタイミングが異なるなら自前で制御する必要があります。

function something (string) {
  console.log(string);
}

setTimeout(something, 1000, 1);
setTimeout(something, 1000, 2);

window.setTimeout() + Queue

どんな場面かといいますとチャットメッセージを受信して画面にappendで追加するのですが、その処理を１個ずつ追加するようにしたいのですが、ほぼ同時に関数が呼ばれるといっぺんに追加されてしまうので、それを間を置いて追加されるようにしたいのです。。

それは「同時に実行」ではなく、「処理間隔が0もしくは0に近い状態」で連続的に実行されています。
関数をキュー管理してやれば、解決可能です。

• WindowOrWorkerGlobalScope.setTimeout() - Web API インターフェイス | MDN
• キュー (コンピュータ) - Wikipedia

const setTimeQueue = ((handleTimeout) => {
  const queue = [];

  return function setTimeQueue (fn, args) {
    queue.push({fn: fn, args: args});

    if (queue.length === 1) {
      setTimeout(handleTimeout, 500, queue, 500);
    }
  };
})(function handleTimeout (queue, delayTime) {
  const entry = queue.shift();

  entry.fn(...entry.args);

  if (queue.length) {
    setTimeout(handleTimeout, delayTime, queue, delayTime);
  }
});

const consoleLog = console.log.bind(console);

setTimeQueue(consoleLog, [1]);
setTimeQueue(consoleLog, [2]);
setTimeQueue(consoleLog, [3]);

Re: koyon さん

Comments

[koyon]

ご回答ありがとうございます。
回答いただいたところ恐縮なのですが、Errorを出すとその呼出が失敗してしまうかと思います。。呼び出しに対して実行はしないといけないのですが、同時に実行するのは避けたいというところなのです・・・。

ただ、
if (executed) {
throw new Error('something() can not be executed in duplicate');
}
の部分を、
if (executed) {
setTimeout(function() {
}, 1000);
・・・
}
と変えて実行してみましたがやはりブロックできませんでした。
お忙しい中ありがとうございます。

[think49]

> 回答いただいたところ恐縮なのですが、Errorを出すとその呼出が失敗してしまうかと思います。。呼び出しに対して実行はしないといけないのですが、同時に実行するのは避けたいというところなのです・・・。
では、いつ実行するのでしょうか。

> と変えて実行してみましたがやはりブロックできませんでした。
変更タイミングの問題と思います。
「変数 executed の処理中フラグは非同期処理が完了したタイミングで変更してください」と書いた通りです。

[koyon]

ありがとうございます。
もう少し自分で試してみます。

[think49]

結局、いつ実行するのでしょうか。
親記事の「タイマー管理」に書いたのと同じタイミングでしょうか。

なお、do_something(); が「非同期処理」なら今出ているコードだけでは対応できません(そうでないと質問が成り立たないので、非同期処理であるとは思っていますが、まだ答えを貰っていませんね…)。
do_something() の開始直前、終了直後でフラグを立てる必要がありますが、終了直後は「コールバック処理」か do_something() 内部コードに追記しなければなりません。

[think49]

> 結局、いつ実行するのでしょうか。
キュー処理と勝手に想像していました。
setTimeoutもキューですね。
https://ja.wikipedia.org/wiki/%E3%82%AD%E3%83%A5%E3%83%BC_(%E3%82%B3%E3%83%B3%E3%83%94%E3%83%A5%E3%83%BC%E3%82%BF)

[koyon]

返信が遅くなり申し訳ございません。
do_something(); と書いた部分は単にjqueryでDOMをappendするだけの処理なので非同期処理とは言えないかと思います。

関数を呼び出す側は具体的にはメッセージを受信するごとに非同期に呼び出します。

どんな場面かといいますとチャットメッセージを受信して画面にappendで追加するのですが、その処理を１個ずつ追加するようにしたいのですが、ほぼ同時に関数が呼ばれるといっぺんに追加されてしまうので、それを間を置いて追加されるようにしたいのです。。

[think49]

> どんな場面かといいますとチャットメッセージを受信して画面にappendで追加するのですが、その処理を１個ずつ追加するようにしたいのですが、ほぼ同時に関数が呼ばれるといっぺんに追加されてしまうので、それを間を置いて追加されるようにしたいのです。。

それは「同時に実行」ではなく、「連続実行されるインターバルが短い」が正しい表現ですね。
そうなると、解決へのアプローチが全く違います。
初めからそこまで詳細に書いてほしかったところです。

とりあえず、「キューに入れてsetTimeoutでインターバルを置きながら実行」で解決できます。

[think49]

親記事に追記しました。

[koyon]

「キューに入れてsetTimeoutでインターバルを置きながら実行」で解決しました！お忙しい中コードを書いてくださいましてありがとうございました。こんなコードは自分にはヒントをいただいても100%無理でした。
> 初めからそこまで詳細に書いてほしかったところです。
・・・余計なお手間をかけて申し訳ありませんでした。

Answer 2

var is_processing = false;
const wait = 1000; // <------------------- 別に定数でよい気がする

function somefunc() {
   //var wait = 0; // <------------------- 定数化したら不要
   if (is_processing == false) { // <----- 処理中でなかったらsetTimeoutすればいいんでは？
      setTimeout(function() {
          // 処理
          is_processing = true;
   　　　 do_something();
          is_processing = false; // <------ 処理が終わったらflag-OFF
      }, wait);
   }
   // is_processing = false; // <--------- これはいらんでしょ。
}

Answer 3

setTimeoutした後に(タイマーセットしただけでdo_something();が実行されてないのに)
is_processing = false;してるのが問題のように思います。

最後のis_processing = false;は消して
setTimeoutは下記ではないでしょうか？

setTimeout(function() {
    // 処理
    is_processing = true;
    do_something(); 
    is_processing = false;
}, wait); 

Comments

[koyon]

ご回答ありがとうございます。
どうも自分はjavascriptの基本がわかっていないようです。。

setTimeout(function() {
// 処理
is_processing = true;
do_something();
}, wait);
is_processing = false;

と書くとsetTimeout(function()が実行されたあとに、is_processing = false;が実行されると思っているのですが、順番に実行されるわけではないのですね・・・？

お手数おかけしております。

[shun-K]

setTimeoutは
「setTimeout(関数,待ち時間);」を実行すると
「『[関数]を[待ち時間]後に実行してね』ってタイマーセットする」だけです。
タイマーセットしただけなので[関数]はまだ実行されてません。

[koyon]

なるほど・・もう少し勉強する必要がありまそうです。。
ありがとうございます。