# 项目说明

一个基于 Gitee 的 “说说”,通过在 gitee 仓库中的 issue 进行说说的展示。项目灵感来自于:微博

image-20200921161543706

# 开坑记录

项目最早写于 2020 年 8 月 9 日,但当时的做法是通过外部载入各种依赖(JQuery、marked 等)进行的,虽然中间还有一次试图将其并入 js 内部,但采用的方式仅仅是通过 jQuery 的 getScript 方式,由于同时间所用 Hexo 博客主题作者更新了 pjax,导致出现了一些出人意料地错误。直到 9 月 20 日,最终决定通过 webpack 打包,将其放在一起并放弃 jQuery(为了减少体积)。

# 基本架构

为了方便使用,采用了类似 jQuery 的写法。

// 导入代码高亮模块
const hljs = require("./js/highlight.min");
//// 导入 marked 解析模块
const marked = require("./js/marked.min");
(function (window, undefiend) {
  let Speak = function (obj) {
    // 传入一个对象
    return new Speak.prototype.init(obj);
  };
  Speak.prototype = {
    constructor: Speak,
    init: function (obj) {
      for (let i in obj) {
        this[i] = obj[i];
      }
      // 调用初始化方法
      return this;
    },
  };
  Speak.extend = Speak.prototype.extend = function (obj) {
    for (var key in obj) {
      this[key] = obj[key];
    }
  };
  // 插入元素方法
  Speak.extend({});
  // 对象方法
  Speak.prototype.extend({
    s: 1,
  });
  Speak.prototype.init.prototype = Speak.prototype;
  window.Speak = Speak;
})(window);

其好处就是在使用时只需要实例化 Speak 对象即可完成一切。

# 第一个问题:原生 JS 发送异步请求

由于一开始的写法是获取与创建是分开写的,即获取后返回一个 promise 对象,通过 then 方法在将获取到的数据进行创建(渲染)。因此放弃 jQuery 的 Ajax 方法后也要返回一个 Promise 对象,这样才能以最小的成本兼容以前的写法。

参数 _this 调用时传入 this

getSpeak: function (_this) {
    return new Promise((resolve, reject) => {
        let url =
            "https://gitee.com/api/v5/repos/" +
            _this.owner +
            "/" +
            _this.repo +
            "/issues?state=open&sort=created&direction=desc&page=" +
            _this.page +
            "&per_page=" +
            _this.per_page +
            "&creator=" +
            _this.owner;
        // 创建核心对象
        let xhr = new XMLHttpRequest();
        // 发送请求
        xhr.open("get", url);
        // 监听请求
        xhr.onreadystatechange = () => {
            if (xhr.readyState === 4) {
                // 如果成功则执行
                if (/^(2|3)\d{2}$/.test(xhr.status)) {
                    let date = xhr.responseText;
                    _this.text = [];
                    _this.total_count = xhr.getResponseHeader("total_count");
                    _this.total_page = Math.ceil(_this.total_count / _this.per_page);
                    if (date) {
                        date = JSON.parse(date);
                        for (let i in date) {
                            var temp = {};
                            temp.comments = date[i]["comments"];
                            temp.body = Speak.getBody(date[i]["body"]);
                            temp.labels = Speak.getLabels(_this, date[i]["labels"]);
                            temp.created_at = Speak.getTime(date[i]["created_at"]);
                            temp.html_url = date[i]["html_url"];
                            _this.text.push(temp);
                        }
                    }
                    resolve(date, xhr);
                    return;
                }
                // 失败执行
                reject(xhr.statusText, xhr);
            }
        };
        // 发送请求数据
        xhr.send(null);
    });
},

调用 API 后,将返回的数据再次进行提取与处理即( getBodygetLabels 等方法),并将结果放入一个临时的对象,将其对象添加到数组。等渲染时遍历此数组即可。因此这个数组大概是这样的:

[
  {
    // 内容
    comments: "内容",
    labels: "标签",
    created_at: "创建时间",
    html_url: "当前issue的地址",
  },
  {
    // 内容
    comments: "内容",
    labels: "标签",
    created_at: "创建时间",
    html_url: "当前issue的地址",
  },
];

# 第二个问题:创建元素

jQuery 的工厂函数过于好用,但为了减少体积,不得不抛弃。因此便遇到了另一个问题,dom 元素的操作。

  1. 由于 gitee 的图片是带有防盗链的,因此需要在头部插入一个标签 meta 标签,表示 no-referrer 才可以正常使用其防盗链图片。

    noRefer: function () {
        let element = document.createElement("meta");
        element.name = "referrer";
        element.content = "no-referrer";
        document.head.appendChild(element);
    },
  2. 外部 CSS 的嵌入

    由于使用了打包工具,只需要通过 require 进行加载即可。

    loadingCss: function () {
        let element = document.createElement("style");
        element.innerHTML = require("./css/loading.css")["default"][0][1];
        document.head.appendChild(element);
    },
    speakCss: function () {
        let element = document.createElement("style");
        element.innerHTML = require("./css/Speak.css")["default"][0][1];
        document.head.appendChild(element);
    },
  3. 按钮的插入

    起初并不打算插入翻页按钮,因为嵌入到博客后,每个博客都会有自己的风格及按钮样式,但又为了初始化及使用方便,因此还是决定添加按钮和页码显示的 label。

    createBtn: function (_this){
        var container = document.getElementsByClassName('is-container')[0]
        container.insertAdjacentHTML('afterend',_this.prevBtn)
        container.insertAdjacentHTML('afterend',_this.nextBtn)
        container.insertAdjacentHTML('afterend',_this.pageLabel)
    }

    关于 insertAdjacentHTML 方法可参考:insertAdjacentHTML

# 第三个问题:代码高亮插件 highlight 过大

highlight.min.js 文件已经 100kb 大小了,加上 marked.min.js 34kb,导致最后生成的文件大小 150kb+。

不过没办法,目前无解。

# 如何使用

使用很简单,只需要一个 class 为 container 的容器和一个实例化的 Speak 对象即可。

由于基于某个主题开发,部分样式可能存在细微差别。

<div class="is-container"></div>
<script src="https://unpkg.com/ispeak/index.js"></script>
<script>
  new Speak({
    nickname: "🦄Dreamy.TZK",
    per_page: 5,
    owner: "antmoe",
    repo: "xiaokang.me",
    defaultLabelName: "Default",
    defaultLabelColor: "#ffc107",
    //highlight 样式
    highlightcss:
      "https://cdn.bootcdn.net/ajax/libs/highlight.js/10.1.1/styles/monokai-sublime.min.css",
    emojiLabel: {
      Coder: "🎯",
      日常: "💬",
      Whoiam: "😶",
      想法: "💫",
      TODO: "🚧",
      随便说说: "🎈",
      测试: "👻",
    },
    prevBtn:
      '<a class="btn-beautify button--animated left larger prev red" href="#" title="上一页" style="display:none;float:left" data-pjax-state=""><i class="far fa-hand-point-left fa-fw"></i> 上一页</a>',
    nextBtn:
      '<a class="btn-beautify button--animated larger next red" href="#" title="下一页" style="float: right; display: block;" data-pjax-state=""><i class="far fa-hand-point-right fa-fw"></i> 下一页</a>',
  });
</script>

DEMO:Speak

更新于

请我喝[茶]~( ̄▽ ̄)~*

Dreamy.TZK 微信支付

微信支付

Dreamy.TZK 支付宝

支付宝