通过码云的issue实现一个“说说”Demo

2024-02-29 03:18
文章标签 实现 码云 demo issue

本文主要是介绍通过码云的issue实现一个“说说”Demo,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!


title: Speak开坑记录
katex: false
tags:

  • Speak
    categories:
  • Project
    abbrlink: 3e39cf25
    date: 2020-09-21 17:20:25

项目说明

一个基于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.js34kb,导致最后生成的文件大小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

这篇关于通过码云的issue实现一个“说说”Demo的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/757410

相关文章

Java实现字节字符转bcd编码

《Java实现字节字符转bcd编码》BCD是一种将十进制数字编码为二进制的表示方式,常用于数字显示和存储,本文将介绍如何在Java中实现字节字符转BCD码的过程,需要的小伙伴可以了解下... 目录前言BCD码是什么Java实现字节转bcd编码方法补充总结前言BCD码(Binary-Coded Decima

SpringBoot全局域名替换的实现

《SpringBoot全局域名替换的实现》本文主要介绍了SpringBoot全局域名替换的实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一... 目录 项目结构⚙️ 配置文件application.yml️ 配置类AppProperties.Ja

Python实现批量CSV转Excel的高性能处理方案

《Python实现批量CSV转Excel的高性能处理方案》在日常办公中,我们经常需要将CSV格式的数据转换为Excel文件,本文将介绍一个基于Python的高性能解决方案,感兴趣的小伙伴可以跟随小编一... 目录一、场景需求二、技术方案三、核心代码四、批量处理方案五、性能优化六、使用示例完整代码七、小结一、

Java实现将HTML文件与字符串转换为图片

《Java实现将HTML文件与字符串转换为图片》在Java开发中,我们经常会遇到将HTML内容转换为图片的需求,本文小编就来和大家详细讲讲如何使用FreeSpire.DocforJava库来实现这一功... 目录前言核心实现:html 转图片完整代码场景 1:转换本地 HTML 文件为图片场景 2:转换 H

C#使用Spire.Doc for .NET实现HTML转Word的高效方案

《C#使用Spire.Docfor.NET实现HTML转Word的高效方案》在Web开发中,HTML内容的生成与处理是高频需求,然而,当用户需要将HTML页面或动态生成的HTML字符串转换为Wor... 目录引言一、html转Word的典型场景与挑战二、用 Spire.Doc 实现 HTML 转 Word1

C#实现一键批量合并PDF文档

《C#实现一键批量合并PDF文档》这篇文章主要为大家详细介绍了如何使用C#实现一键批量合并PDF文档功能,文中的示例代码简洁易懂,感兴趣的小伙伴可以跟随小编一起学习一下... 目录前言效果展示功能实现1、添加文件2、文件分组(书签)3、定义页码范围4、自定义显示5、定义页面尺寸6、PDF批量合并7、其他方法

SpringBoot实现不同接口指定上传文件大小的具体步骤

《SpringBoot实现不同接口指定上传文件大小的具体步骤》:本文主要介绍在SpringBoot中通过自定义注解、AOP拦截和配置文件实现不同接口上传文件大小限制的方法,强调需设置全局阈值远大于... 目录一  springboot实现不同接口指定文件大小1.1 思路说明1.2 工程启动说明二 具体实施2

Python实现精确小数计算的完全指南

《Python实现精确小数计算的完全指南》在金融计算、科学实验和工程领域,浮点数精度问题一直是开发者面临的重大挑战,本文将深入解析Python精确小数计算技术体系,感兴趣的小伙伴可以了解一下... 目录引言:小数精度问题的核心挑战一、浮点数精度问题分析1.1 浮点数精度陷阱1.2 浮点数误差来源二、基础解决

Java实现在Word文档中添加文本水印和图片水印的操作指南

《Java实现在Word文档中添加文本水印和图片水印的操作指南》在当今数字时代,文档的自动化处理与安全防护变得尤为重要,无论是为了保护版权、推广品牌,还是为了在文档中加入特定的标识,为Word文档添加... 目录引言Spire.Doc for Java:高效Word文档处理的利器代码实战:使用Java为Wo

Java实现远程执行Shell指令

《Java实现远程执行Shell指令》文章介绍使用JSch在SpringBoot项目中实现远程Shell操作,涵盖环境配置、依赖引入及工具类编写,详解分号和双与号执行多指令的区别... 目录软硬件环境说明编写执行Shell指令的工具类总结jsch(Java Secure Channel)是SSH2的一个纯J