vue-cli ui 服务器代码结构

vue-cli 提供了可视化工具,也就是使用vue ui所启动的cli-ui服务。它实际上是个node服务,且提供了一个使用vue开发的spa页面,收到前端发送的请求时执行一些命令或读取一些文件。而这个node服务使用了apollo-serverexpress。前后端通讯全部依靠graphql进行。

下面,从入口开始分析一下该node服务的基本结构。

该文章默认已经熟悉了apollo-server相关的概念及使用方法。

首先看一下服务是如何启动的:
在运行 vue ui命令式会执行packages/@vue/cli/lib/ui中默认导出的函数

module.exports = (...args) => {
  return ui(...args).catch(err => {
    error(err)
    if (!process.env.VUE_CLI_TEST) {
      process.exit(1)
    }
  })
}

其实也就是执行了上面定义的ui函数:

const { portfinder, server } = require('@vue/cli-ui/server')

async function ui (options = {}, context = process.cwd()) {
  const host = options.host || 'localhost'

  let port = options.port
   // 容错处理及环境变量
  // ...
  const opts = {
    host,
    port,
    graphqlPath: '/graphql',
    subscriptionsPath: '/graphql',
    enableMocks: false,
    enableEngine: false,
    cors: {
      origin: host
    },
    timeout: 1000000,
    quiet: true,
    paths: {
      typeDefs: require.resolve('@vue/cli-ui/apollo-server/type-defs.js'),
      resolvers: require.resolve('@vue/cli-ui/apollo-server/resolvers.js'),
      context: require.resolve('@vue/cli-ui/apollo-server/context.js'),
      pubsub: require.resolve('@vue/cli-ui/apollo-server/pubsub.js'),
      server: require.resolve('@vue/cli-ui/apollo-server/server.js'),
      directives: require.resolve('@vue/cli-ui/apollo-server/directives.js')
    }
  }

  const { httpServer } = server(opts, () => {
   // ...
    const url = `http://${host}:${port}`
    if (options.headless) {
      console.log(port)
    } else {
      openBrowser(url)
    }
  })

  httpServer.on('upgrade', simpleCorsValidation(host))
}

里面创建了一些选项,然后传入server函数执行。
这些选项是直接中关键的就是paths。里边获取了'@vue/cli-ui/apollo-server中的几个文件。在这些文件里定义了apollo-server所需要的typeDefs、resolvers等。
而server函数是在'@vue/cli-ui/server中导出的'@vue/cli-ui/graphql-server

首先看下入口文件,也就是根目录下的graphql-server.js

module.exports = (options, cb = null) => {
  // ....
  cosnt app = express(); //创建expess app
  // 加载类型定义,解析器、context、订阅发布对象等
  let typeDefs = load(options.paths.typeDefs)
  const resolvers = load(options.paths.resolvers)
  const context = load(options.paths.context)
  // ...
  let apolloServerOptions = { /* apollo server 选项 */ }
  const server = new ApolloServer(apolloServerOptions);
  // ...
 // 创建服务器,监听端口...

可以看到,服务器入口很简单:

  • 创建app实例
  • 加载apollo-server所需选项
  • 创建apollo-server实例
  • 创建http服务,监听端口

这样就已经启动了node服务。

回到上面所说的apollo-server的选项,以加载typeDefs为例:

 let typeDefs = load(options.paths.typeDefs);

load函数实际上就是使用require函数将js引入。也就是引入了:

paths {
  typeDefs: require.resolve('@vue/cli-ui/apollo-server/type-defs.js'),
// ...
}

也就是把这个文件通过require加载了进来。

// @vue/cli-ui/apollo-server/type-defs.js
const typeDefs = [gql`
scalar JSON
enum PackageManager {
  npm
  yarn
  pnpm
}
// ...
`
]
const paths = globby.sync(['./schema/*.js'], { cwd: __dirname, absolute: true })
paths.forEach(file => {
  const { types } = require(file)
  types && typeDefs.push(types)
})

module.exports = typeDefs

可以看到,这里除了默认的gql类型定义之外,还从遍历了schema文件夹内的所有js文件,将其导出的types也加入typeDefs中。

其余resolvers等的加载也是同样的方法。

这样我们在入口处向apollo-server构造函数传入的就是汇总后的所有typeDefsresolvers等。

剩下就是对具体的请求的处理方式了。也是cli-ui的关键部分。

当客户端发起一个QueryMutation或其他类型的查询时,会进入对应的同名的resolverresolver做实际的处理,并返回数据。
如下所示:

const projects = require('../connectors/projects')

exports.types = gql`
extend type Query {
  projects: [Project]
}
// ...
`
exports.resolvers = {
  Query: {
    projects: (root, args, context) => projects.list(context),
    // 其他Query类型的resolver
  },
}

这里的代码里为了简洁,将所有的处理逻辑放入了apollo-server/connectors文件夹,在resolver中只需要调用对应导出对象上的方法即可。

[未完待续(下一篇:cli-ui插件化机制实现原理)]

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 151,829评论 1 331
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 64,603评论 1 273
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 101,846评论 0 226
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 42,600评论 0 191
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 50,780评论 3 272
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 39,695评论 1 192
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,136评论 2 293
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 29,862评论 0 182
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 33,453评论 0 229
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 29,942评论 2 233
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,347评论 1 242
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 27,790评论 2 236
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,293评论 3 221
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 25,839评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,448评论 0 181
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 34,564评论 2 249
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 34,623评论 2 249

推荐阅读更多精彩内容