目錄結構
這是《基於nuxt和iview搭建OM後臺管理系統實踐》這一個系列文章的目錄，大致思路如下：
- 簡要介紹OM後臺管理系統，以及開發環境
- 自行開發的公共元件，富文字quill、地圖、上傳元件的封裝過程
- 專案上線流程，自動化打包（Jenkins）
- 專案總結，總結開發過程中的坑點，避免以後再掉坑
前言
上一篇簡要介紹了一下這個專案的專案背景，從這一篇開始我會寫開發公共元件的過程，這一篇講解一下富文字編輯器quill的整合吧。
少廢話，看東西
如動圖所示，為後臺管理系統新增內容的功能頁面，可以看到已經整合了上傳圖片元件和富文字編輯器元件。
富文字編輯器
這個富文字整合了quill這個開源庫 [quill中文文件]。在vue-cli構建的專案中直接引用quill的包一點問題都沒有，但是我用的nuxt.js是基於服務端渲染的，多數情況下會報下面這個錯誤：
window is not defined
複製程式碼這是因為window物件只存在於瀏覽器端，服務端渲染的時候是不存在window物件的。那麼我應該怎麼做呢？？
我還是直接上程式碼吧：
- 第一步在plugins下新建quill外掛檔案nuxt-quill-plugins.js
// 檔案plugins/nuxt-quill-plugins.js
import Vue from 'vue'
// import VueQuillEditor from 'vue-quill-editor'
// Vue.use(VueQuillEditor) 直接引用會報錯
if (process.browser) {
//加一個瀏覽器端判斷，只在瀏覽器端才渲染就不會報錯了
const VueQuillEditor = require('vue-quill-editor/dist/ssr')
Vue.use(VueQuillEditor)
}
複製程式碼- 第二步以外掛形式配置quill
//檔案nuxt.config.js，省略其他程式碼
plugins: [
'~plugins/iview-ui',
'~plugins/qs',
'~plugins/urlencode',
{src: '~plugins/nuxt-quill-plugin.js',ssr: false}
],
複製程式碼- 第三步開始封裝元件
//檔案 components/full-editor.vue
<template>
<section class="container">
<!-- <form id="uploadForm"> -->
<input class="file" type="file" style="display:none" id="file" ref="input" @change="doUpload">
<!-- </form> -->
<div class="quill-editor"
ref="myQuillEditor"
:content="content"
@change="onEditorChange($event)"
@blur="onEditorBlur($event)"
@focus="onEditorFocus($event)"
@ready="onEditorReady($event)"
v-quill:myQuillEditor="editorOption">
</div>
</section>
</template>
<script>
import {qiniuConfig,quillEditorConfig} from '~/config';//七牛上傳和富文字toolbar配置檔案
const QiniuUPToken = require('qiniu-uptoken');//前端生成七牛上傳token
import axios from '~/plugins/axios';
export default {
name: "full-editor",
head() {
return {
link: [
{
href: "/full-editor/quill.core.css",
rel: "stylesheet"
},
{
href: "/full-editor/quill.snow.css",
rel: "stylesheet"
},
{
href: "/full-editor/quill.bubble.css",
rel: "stylesheet"
}
]
};
},
data() {
const self = this;
return {
content: "",
editorOption: {
// some quill options
modules: {
toolbar: {
container:quillEditorConfig.toolbarOptions,
handlers:{
'image':function(){
// console.log(this)
this.quill.format('image', false);//禁用quill內部上傳圖片方法
self.imgHandler(this)
}
}
},
},
placeholder: '請輸入資訊',
theme: "snow",
quill:''
}
};
},
mounted() {
// console.log("app init");
},
methods: {
onEditorBlur(editor) {
// console.log("editor blur!", editor);
},
onEditorFocus(editor) {
// console.log("editor focus!", editor);
},
onEditorReady(editor) {
// console.log("editor ready!", editor);
},
onEditorChange({ editor, html, text }) {
// console.log("editor change!", editor, html, text);
this.content = html;
this.$emit('editorContent',html)
// console.log(this.content);
},
imgHandler(handle){
this.quill = handle.quill;
var inputfile = document.getElementById('file');
inputfile.click();
},
doUpload(){
let files = document.getElementById('file');
// console.log(files.files[0]);
let uptoken = QiniuUPToken(qiniuConfig.access_key,qiniuConfig.secret_key,qiniuConfig.bucketname)
// console.log(uptoken);
this.qiniuUpload(files.files[0],uptoken);
},
qiniuUpload(file, token){
let param = new FormData(); //建立form物件
param.append('file',file,file.name);//通過append向form物件新增資料
param.append('token',token);//新增form表單中其他資料
// console.log(param. `get('file')); //FormData私有類物件，訪問不到，可以通過get判斷值是否傳進去
let config = {
headers:{'Content-Type':'multipart/form-data'}
}; //新增請求頭
axios.post(qiniuConfig.action_url,param,config)
.then(res=>{
// console.log(res);
// console.log(this.quill);
let length = this.quill.getSelection().index;
const imgUrl = qiniuConfig.pic_hostname+res.key;//插入上傳的圖片
this.quill.insertEmbed(length, 'image', imgUrl);
// this.quill.insertEmbed(index, 'image', imgUrl);//插入上傳的圖片
// console.log(res.data);
})
.then((err)=>{
// console.log(err)
})
}
}
};
</script>
<style scoped>
.container {
width: 100%;
margin: 0 auto;
/* padding: 10px 0; */
}
.quill-editor {
min-height: 200px;
max-height: 400px;
overflow-y: auto;
}
</style>
複製程式碼封裝元件需要注意的幾個點：
- 在元件頁面（head方法）引用css樣式，不要全域性引用，head方法的配置具體參考nuxt官方文件，這裡不做過多贅述
<script>
export default {
head() {
return {
link: [
{
href: "/full-editor/quill.core.css",
rel: "stylesheet"
},
{
href: "/full-editor/quill.snow.css",
rel: "stylesheet"
},
{
href: "/full-editor/quill.bubble.css",
rel: "stylesheet"
}
]
};
},
}
</script>
複製程式碼- 為了保持程式碼的簡介，我這裡把quill工具欄的配置檔案放到了config/index.js檔案裡了
// 檔案config/index.js
/**
* @description 富文字編輯器quill的配置檔案
* @argument 參考文件https://sheweifan.github.io/2018/01/07/nuxt-quill-qiniu/
* @argument quill中文文件https://github.com/BingKui/QuillChineseDoc/blob/master/SUMMARY.md
*/
export const quillEditorConfig = {
toolbarOptions:[
["bold", "italic", "underline", "strike"], // 切換按鈕
["blockquote", "code-block"],
// [{ header: 1 }, { header: 2 }], // 使用者自定義按鈕值
[{ list: "ordered" }, { list: "bullet" }],
[{ script: "sub" }, { script: "super" }], // 上標/下標
[{ indent: "-1" }, { indent: "+1" }], // 減少縮排/縮排
[{ direction: "rtl" }], // 文字下劃線
[{ size: ["small", false, "large", "huge"] }], // 使用者自定義下拉
[{ header: [1, 2, 3, 4, 5, 6, false] }],
[{ color: [] }, { background: [] }], // 主題預設下拉，使用主題提供的值
[{ font: [] }],
[{ align: [] }],
['image'],//上傳圖片
['video'],//視訊
["clean"] // 清除格式
]
}
複製程式碼- 元件原生圖片上傳是直接把圖片處理成base64位的儲存，我這裡為了儲存方便，會把圖片上傳到七牛上，這裡也遇到了一點小坑。首先要禁用quill內部上傳圖片方法，然後用一個隱藏的input[type=file]實現選擇圖片，然後模擬七牛表單提交不重新整理的操作，最終實現圖片上傳七牛（還得在前端應用一個庫生成token），以上完整程式碼裡有呈現。
- 編輯時需要傳遞content到子元件我這裡用的ref
// 父元件
<template>
<div class="body">
<full-editor
ref="myFullEditor"
v-model="formItem.body"
@editorContent="editorContent"
>
</full-editor>
</div>
</template>
<script>
const fullEditor = () => import("@/components/full-editor");
export default {
layout: "nav",
components: {
fullEditor
},
mounted() {
this.loadData();//載入資料
this.$refs.myFullEditor.content = this.body;//父元件給富文字編輯器傳遞值
}
}
</script>
複製程式碼總結
封裝一個富文字元件，開始做之前以為會蠻容易的，以為就引用一下就就可以了，沒想到會遇到以上的那些坑，最終在百度和翻閱github後很好的解決了問題，最終也封裝完成也滿足了需求，後續我會找個時間剔除一些業務程式碼把元件放到github上。
系列文章連結
以下為本系列的文章合集，在此列出便於查閱：