1谁鳍、用法

需要明確的是戈锻，如果可以使用 Web 端組件技術(shù)實(shí)現(xiàn)的話(huà)請(qǐng)盡量使用 Web 端技術(shù)（如 vue宝鼓、react 組件）也搓，使用自定義組件請(qǐng)按需使用棍辕。這是因?yàn)樽远x組件外層會(huì)被包裹上 kbone 的自定義組件，而當(dāng)自定義組件的實(shí)例數(shù)量達(dá)到一定量級(jí)的話(huà)还绘，理論上是會(huì)對(duì)性能造成一定程度的影響。

要在 kbone 中使用自定義組件栖袋，需要將所有自定義組件和其依賴(lài)放到一個(gè)固定的目錄拍顷，這個(gè)目錄可以自己擬定，假設(shè)這個(gè)目錄為 src/custom-components：

1.1 修改 webpack 插件配置

在 mp-webpack-plugin 這個(gè)插件的配置中的 generate 字段內(nèi)補(bǔ)充 wxCustomComponent塘幅，其中 root 是組件根目錄昔案，即上面提到的目錄：src/custom-component，usingComponents 則用來(lái)配置要用到的自定義組件电媳。

module.exports = {
  generate: {
    wxCustomComponent: {
      root: path.join(__dirname, '../src/custom-components'),
      usingComponents: {
        'comp-a': 'comp-a/index',
        'comp-b': {
          path: 'comp-b/index',
          props: ['propa', 'propb'],
          events: ['someevent'],
        },
      },
    },
  },
  // ... other options
}

usingComponents 里的聲明和小程序頁(yè)面的 usingComponents 字段類(lèi)似踏揣。鍵為組件名，值可以為組件相對(duì) root 字段的路徑匾乓，也可以是一個(gè)配置對(duì)象捞稿。這個(gè)配置對(duì)象的 path 為組件相對(duì)路徑，props 表示要這個(gè)組件會(huì)被用到的 properties拼缝，events 表示這個(gè)組件會(huì)被監(jiān)聽(tīng)到的事件娱局。

1.2 將自定義組件放入組件根目錄

下面以 comp-b 組件為例：

<!-- comp-b.wxml -->
<view>comp-b</view>
<view>propa: {{propa}} -- propb: {{propb}}</view>
<button bindtap="onTap">click me</button>
<slot></slot>
// comp-b.js
Component({
  properties: {
  propa: {type: String, value: ''},
  propb: {type: String, value: ''},
  },
  methods: {
  onTap() {
    this.triggerEvent('someevent')
  },
  },
})

1.3 使用自定義組件

假設(shè)使用 vue 技術(shù)，然后下面同樣以 comp-b 組件為例：

<template>
  <div>
  <comp-b :propa="propa" :propb="propb" @someevent="onEvent">
    <div>comp-b slot</div>
  </comp-b>
  </div>
</template>
<script>
export default {
  data() {
  return {propa: 'propa-value', propb: 'propb-value'}
  },
  methods: {
  onEvent(evt) {
    console.log('someevent', evt)
  },
  },
}
</script>

PS：如果使用 react 等其他框架其實(shí)和 vue 同理咧七，因?yàn)樗鼈兊牡讓佣际钦{(diào)用 document.createElement 來(lái)創(chuàng)建節(jié)點(diǎn)衰齐。當(dāng)在 webpack 插件配置聲明了這個(gè)自定義組件的情況下，在調(diào)用 document.createElement 創(chuàng)建該節(jié)點(diǎn)時(shí)會(huì)被轉(zhuǎn)換成創(chuàng)建 wx-custom-component 標(biāo)簽继阻，類(lèi)似于內(nèi)置組件的 wx-component 標(biāo)簽耻涛。

2废酷、案例

在 kbone-advanced 目錄下創(chuàng)建 04-custom-components 目錄。本案例在這個(gè)目錄下實(shí)現(xiàn)抹缕。

2.1 創(chuàng)建 package.json

cd 04-custom-components
npm init -y

編輯 package.json：

{
  "scripts": {
    "mp": "cross-env NODE_ENV=production webpack --config build/webpack.mp.config.js --progress --hide-modules"
  },
  "dependencies": {
    "vue": "^2.5.11"
  },
  "browserslist": [
    "> 1%",
    "last 2 versions",
    "not ie <= 8"
  ],
  "devDependencies": {
    "babel-core": "^6.26.0",
    "babel-loader": "^7.1.2",
    "babel-preset-env": "^1.6.0",
    "babel-preset-stage-3": "^6.24.1",
    "cross-env": "^5.0.5",
    "css-loader": "^0.28.7",
    "extract-text-webpack-plugin": "^3.0.2",
    "file-loader": "^1.1.4",
    "html-webpack-plugin": "^4.0.0-beta.5",
    "mini-css-extract-plugin": "^0.5.0",
    "mp-webpack-plugin": "latest",
    "optimize-css-assets-webpack-plugin": "^5.0.1",
    "stylehacks": "^4.0.3",
    "vue-loader": "^15.7.0",
    "vue-template-compiler": "^2.6.10",
    "webpack": "^4.29.6",
    "webpack-cli": "^3.2.3"
  }
}

安裝依賴(lài)包：

npm install

2.2 配置 webpack

在 04-custom-components 目錄下創(chuàng)建 build 文件夾澈蟆，在文件夾下創(chuàng)建 webpack.mp.config.js 文件，內(nèi)容如下：

const path = require('path')
const webpack = require('webpack')
const MiniCssExtractPlugin = require('mini-css-extract-plugin')
const { VueLoaderPlugin } = require('vue-loader')
const OptimizeCSSAssetsPlugin = require('optimize-css-assets-webpack-plugin');
const TerserPlugin = require('terser-webpack-plugin')
const MpPlugin = require('mp-webpack-plugin') // 用于構(gòu)建小程序代碼的 webpack 插件

const isOptimize = false // 是否壓縮業(yè)務(wù)代碼歉嗓，開(kāi)發(fā)者工具可能無(wú)法完美支持業(yè)務(wù)代碼使用到的 es 特性丰介，建議自己做代碼壓縮

module.exports = {
  mode: 'production',
  entry: {
    index: path.resolve(__dirname, '../src/index/main.mp.js'),
  },
  output: {
    path: path.resolve(__dirname, '../dist/mp/common'), // 放到小程序代碼目錄中的 common 目錄下
    filename: '[name].js', // 必需字段，不能修改
    library: 'createApp', // 必需字段鉴分，不能修改
    libraryExport: 'default', // 必需字段哮幢，不能修改
    libraryTarget: 'window', // 必需字段，不能修改
  },
  target: 'web', // 必需字段志珍，不能修改
  optimization: {
    runtimeChunk: false, // 必需字段橙垢，不能修改
    splitChunks: { // 代碼分隔配置，不建議修改
      chunks: 'all',
      minSize: 1000,
      maxSize: 0,
      minChunks: 1,
      maxAsyncRequests: 100,
      maxInitialRequests: 100,
      automaticNameDelimiter: '~',
      name: true,
      cacheGroups: {
        vendors: {
          test: /[\\/]node_modules[\\/]/,
          priority: -10
        },
        default: {
          minChunks: 2,
          priority: -20,
          reuseExistingChunk: true
        }
      }
    },

    minimizer: isOptimize ? [
      // 壓縮CSS
      new OptimizeCSSAssetsPlugin({
        assetNameRegExp: /\.(css|wxss)$/g,
        cssProcessor: require('cssnano'),
        cssProcessorPluginOptions: {
          preset: ['default', {
            discardComments: {
              removeAll: true,
            },
            minifySelectors: false, // 因?yàn)?wxss 編譯器不支持 .some>:first-child 這樣格式的代碼伦糯，所以暫時(shí)禁掉這個(gè)
          }],
        },
        canPrint: false
      }),
      // 壓縮 js
      new TerserPlugin({
        test: /\.js(\?.*)?$/i,
        parallel: true,
      })
    ] : [],
  },
  module: {
    rules: [
      {
        test: /\.css$/,
        use: [
          MiniCssExtractPlugin.loader,
          'css-loader'
        ],
      },
      {
        test: /\.vue$/,
        loader: 'vue-loader',
      },
      {
        test: /\.js$/,
        use: [
          'babel-loader'
        ],
        exclude: /node_modules/
      },
      {
        test: /\.(png|jpg|gif|svg)$/,
        loader: 'file-loader',
        options: {
          name: '[name].[ext]?[hash]'
        }
      }
    ]
  },
  resolve: {
    extensions: ['*', '.js', '.vue', '.json']
  },
  plugins: [
    new webpack.DefinePlugin({
      'process.env.isMiniprogram': process.env.isMiniprogram, // 注入環(huán)境變量柜某，用于業(yè)務(wù)代碼判斷
    }),
    new MiniCssExtractPlugin({
      filename: '[name].wxss',
    }),
    new VueLoaderPlugin(),
    new MpPlugin(require('./miniprogram.config.js')),
  ],
}

在 04-custom-components/build 文件夾下創(chuàng)建 miniprogram.config.js 文件，內(nèi)容如下：

const path = require('path')

module.exports = {
    origin: 'https://test.miniprogram.com',
    entry: '/',
    router: {
        index: ['/'],
    },
    redirect: {    
        notFound: 'index',    
        accessDenied: 'index',
    },
    generate: {
        wxCustomComponent: {
            root: path.join(__dirname, '../src/custom-components'),
            usingComponents: {
                'comp-a': {
                    path: 'comp-a',
                    props: ['prefix', 'suffix'],
                    events: ['someevent'],
                },
                'comp-b': {
                    path: 'comp-b/index',
                    props: ['prefix'],
                },
                'comp-c': 'comp-c',
            },
    },
    // 構(gòu)建完成后是否自動(dòng)安裝小程序依賴(lài)敛纲。'npm'：使用 npm 自動(dòng)安裝依賴(lài)
        autoBuildNpm: 'npm'
    },
    app: {
        navigationBarTitleText: 'miniprogram-project',
    },
    projectConfig: {
        appid: '',
    projectname: 'custom-components',
    },
    packageConfig: {
        author: 'Felixlu',
    },
}

2.3 編寫(xiě)案例有關(guān)組件

2.3.1 創(chuàng)建 main.mp.js

在項(xiàng)目根目錄下創(chuàng)建 /src/index喂击，在 index 下創(chuàng)建 main.mp.js 文件，內(nèi)容如下：

import Vue from 'vue'
import App from './App.vue'

export default function createApp() {
  const container = document.createElement('div')
  container.id = 'app'
  document.body.appendChild(container)

  return new Vue({
    el: '#app',
    render: h => h(App)
  })
}

2.3.2 創(chuàng)建 App.vue 組件

在 /src/index 下創(chuàng)建 App.vue 組件淤翔，內(nèi)容為：

<template>
  <div class="cnt">
    <h2>kbone</h2>
    <comp-a ref="compA" class="block" :prefix="prefixA" :suffix="suffixA" @someevent="onEvent">
      <div>comp-a slot</div>
    </comp-a>
    <comp-b class="block" :prefix="prefixB">
      <div>comp-b slot</div>
    </comp-b>
    <comp-c class="block">
      <div>comp-c slot</div>
    </comp-c>
    <button class="btn" @click="onClick">update</button>
  </div>
</template>

<script>
export default {
  name: 'App',
  data() {
    return {
      suffixA: 'suffix-a',
      prefixB: 'prefix-b',
    }
  },
  methods: {
    onClick() {
      this.prefixA = 'prefix-new-a'
      this.prefixB = 'prefix-new-b'

      this.$refs.compA._wxCustomComponent.printf()
    },

    onEvent(evt) {
      console.log('someevent', evt)
    },
  },
}
</script>

<style>
.cnt {
  margin: 15px;
}

.block {
  border: 1px solid #ddd;
  padding: 15px;
  box-sizing: content-box;
  display: block;
  margin-bottom: 15px;
}

.btn {
  margin-top: 15px;
  display: block;
  width: 100%;
  height: 30px;
  line-height: 30px;
  text-align: center;
  font-size: 20px;
  border: 1px solid #ddd;
}
</style>

2.3.3 創(chuàng)建 comp-a 組件

在根目錄下創(chuàng)建 /src/custom-components 文件夾翰绊，在這個(gè)文件夾下創(chuàng)建小程序原生組件 comp-a，四個(gè)文件內(nèi)容如下：

/src/custom-components/comp-a.wxml

<view>comp-a</view>
<button class="btn" bindtap="onTap">comp-a button</button>
<view><text class="prefix">{{prefix}}</text>-{{str}}-<text class="suffix">{{suffix}}</text></view>
<slot></slot>

/src/custom-components/comp-a.js

const _ = require('./common/utils')

Component({
  properties: {
    prefix: {
      type: String,
      value: 'defaultPrefix',
    },
    suffix: {
      type: String,
      value: 'defaultSuffix',
    },
  },
  data: {
    str: _.getWords() + 'comp-a',
  },
  methods: {
    onTap() {
      this.triggerEvent('someevent', {
        detail: {
          from: 'comp-a',
        },
      })
    },

    printf() {
      console.log('I am comp-a')
    },
  },
})

/src/custom-components/common/utils.js

module.exports = {
  getWords() {
    return 'Hello, '
  },
}

/src/custom-components/comp-a.json

{
  "component": true
}

/src/custom-components/comp-a.wxss

// 內(nèi)容為空

2.3.4 創(chuàng)建 comp-b 組件

在根目錄下創(chuàng)建 /src/custom-components/comp-b 文件夾旁壮，在這個(gè)文件夾下創(chuàng)建小程序原生組件 comp-b监嗜，四個(gè)文件內(nèi)容如下：

/src/custom-components/comp-b/index.wxml

<view>comp-b</view>
<view><text class="prefix">{{prefix}}</text>-{{str}}-<text class="suffix">{{suffix}}</text></view>
<slot></slot>

/src/custom-components/comp-b/index.js

const _ = require('../common/utils')

Component({
  properties: {
    prefix: {
      type: String,
      value: 'defaultPrefix',
    },
    suffix: {
      type: String,
      value: 'defaultSuffix',
    },
  },
  data: {
    str: _.getWords() + 'comp-b',
  },
})

/src/custom-components/comp-b/index.json

{
  "component": true
}

/src/custom-components/comp-b/index.wxss

.prefix, .suffix {
  color: green;
}

2.3.5 創(chuàng)建 comp-c 組件

在 /src/custom-components 文件夾下創(chuàng)建小程序原生組件 comp-c，四個(gè)文件內(nèi)容如下：

/src/custom-components/comp-c.wxml

<view>comp-c</view>
<comp-d>
  <view>comp-d slot</view>
</comp-d>
<slot></slot>

/src/custom-components/comp-c.js

Component({})

/src/custom-components/comp-c.json

{
  "component": true,
  "usingComponents": {
    "comp-d": "./comp-d"
  }
}

/src/custom-components/comp-c.wxss

// 內(nèi)容為空

2.3.6 創(chuàng)建 comp-d 組件

在 /src/custom-components 文件夾下創(chuàng)建小程序原生組件 comp-d抡谐，四個(gè)文件內(nèi)容如下：

/src/custom-components/comp-d.wxml

<view>comp-d</view>
<slot></slot>

/src/custom-components/comp-d.js

Component({})

/src/custom-components/comp-d.json

{
  "component": true
}

/src/custom-components/comp-d.wxss

// 內(nèi)容為空

2.4 小程序端效果預(yù)覽

npm run mp