node.jsのmodule.exportsで循環参照

Question

あるwebアプリを作っててそこではexpressとsocketioを使用しています。

expressのインスタンスの処理等とルーティングを分けようと思って

app.jsとroute.jsに分けました。

そしてあるルートでsocketioの通信をしたいのですが、socketioの通信を使用するためにはapp.jsのインスタンスが必要です。

app.jsをA,route.jsをR、socketioをSとします

AがRを必要としてRがSを必要として、SがAを必要としている状態です。

いろいろググってDI(依存性注入)や極限までrequireしない方法なども試してみましたが駄目でした。

なんとか3つのファイルに分けたままで解決する方法はないですか？
お願いします。

もっと分割してもかまいません。

Answer 1

socket.ioはio.attachを使用して、後からhttpServerへ依存できます。

以下はnode app.jsでサーバーを立てながら、循環参照を避けて3つのファイルをmodule.exportsで輸出する例です。

// app.js
const createHttpServer = require('http').createServer
const express = require('express')
const io = require('./io')
const routes = require('./routes')

const app = express()
const httpServer = createHttpServer(app)

app.use(routes)
io.attach(httpServer)

if (module.parent == null) {
  httpServer.listen(process.env.PORT || 59798, () => {
    console.log('listen on port', httpServer.address().port)
  })
}

module.exports = app

// io.js
const socketIo = require('socket.io')

const io = socketIo()
io.on('connect', function (socket) {
  console.log(`1. connected. wait foo event by client(${socket.id})`)
  socket.on('foo', function () {
    console.log('3. receive foo event from client')
    socket.send('4. receive bar message from server')
  })
  socket.on('message', function (message) {
    console.log(message)
  })
})

module.exports = io

// routes.js
const createRouter = require('express').Router
const io = require('./io')

const routes = createRouter()
routes.get('/', (req, res) => {
  io.emit('message', 'visit other client at `/`')
  res.end(`
    <script src="/socket.io/socket.io.js"></script>
    <script>
    var socket = io()

    socket
    .on('connect', function () {
      console.log('2. connected. send foo event to server')
      socket.emit('foo')
    })
    .on('message', function (message) {
      console.log(message)
    })
    </script>
  `)
})

module.exports = routes

Comments

[退会済みユーザー]

io.attachなんてあるんですね。ソースコードまで載せて丁寧に回答していただいてありがとうございました。
自分が挑戦したらなぜか普通にやってもできたのですがio.attachが効いてるのかもしれません。

http://lv7777.hatenablog.com/entry/2016/06/13/221007