鸿蒙electron跨端框架PC片段匣实战:给常用代码片段一个能搜索、复制和整理的桌面仓
前言
欢迎加入鸿蒙PC开发者社区,共同打造开发者工具生态:鸿蒙PC开发者社区 :https://harmonypc.csdn.net/
项目开源地址:https://AtomGit.com/lqjmac/ele-pianduanxia
片段匣这一篇,我更想按一次真实改项目的节奏来写。
常用代码如果散在各个项目里,真正要复用时反而找不到。片段工具要解决快找、快看、快复制。
它面向的是经常复用 Vue、TypeScript、Electron、样式片段的开发者。
这一篇我会把它当成开发者自己的“代码抽屉”来拆。
重点不在于保存多少片段,而是当你真正需要那段代码时,能不能用搜索、标签和复制动作马上拿到。
一、先确认片段库要解决什么
1.1 片段匣真正要解决什么
常用代码如果散在各个项目里,真正要复用时反而找不到。片段工具要解决快找、快看、快复制。
开发者收藏代码最常见的问题不是没有保存,而是保存以后找不到、看不懂、复制时还要重新改。
第一版我只做围绕复用的动作:
- 片段要能按语言和触发场景找回来
- 代码预览要足够清楚,不能只显示标题
- 复制动作要比打开原项目更快
1.2 为什么不做成大而全
代码片段管理器如果一开始就塞进太多功能,会很快变成一个难维护的综合面板。
我没有在第一版里做在线同步、团队共享和自动补全,因为那些已经接近 IDE 插件的范畴。
| 能力 | 这一版怎么做 | 取舍原因 |
|---|---|---|
| 分类筛选 | 保留语言、场景字段 | 片段越多越依赖分类 |
| 代码预览 | 放在主工作区 | 复制前要能快速确认 |
| 使用说明 | 和代码一起保存 | 未来的自己也需要上下文 |
| 团队共享 | 暂缓 | 第一版先服务个人高频复用 |
这样做出来的工具不会替代 IDE,但能补上“跨项目片段回收”的空白。
二、文件分工对应代码片段流
2.1 主要文件职责
| 文件 | 职责 | 这篇关注点 |
|---|---|---|
| Home.vue | 组织片段工作台 | 把分类、列表、预览和动作串起来 |
| NoteSidebar.vue | 负责片段索引 | 语言筛选、搜索和选中状态都在这里更自然 |
| NoteEditor.vue | 编辑代码和说明 | 代码、触发词、使用场景要能一起维护 |
| NoteToolbar.vue | 放高频命令 | 新建片段、复制代码、导出清单 |
| useNotes.ts | 管片段数据 | 本地保存、筛选排序、当前片段选择 |
| useNativeBridge.ts | 处理复制兜底 | 复制代码是这类工具最核心的桌面动作 |
这里我更关注组件承担的动作,而不是名字是否足够“片段化”。
只要边界清楚,后面把通用组件名换成 Snippet 前缀也不难。
三、整体结构围绕搜索和复制
3.1 页面结构图
片段匣结构图展示了片段分类、代码预览和复制动作的组合。
3.2 布局为什么这样分
片段匣采用的是语言筛选 + 片段列表 + 代码预览和说明区。
它的浏览路径很短:先按语言缩小范围,再看代码,最后复制。
| 区域 | 承担的任务 | 设计注意点 |
|---|---|---|
| 语言筛选 | 缩小搜索范围 | 语言名和标签要醒目 |
| 片段列表 | 找到可复用代码 | 标题、触发词比长描述更重要 |
| 代码预览 | 判断能不能直接用 | 字体、换行、滚动都要照顾代码阅读 |
| 工具栏 | 复制和导出 | 复制按钮要足够靠近预览区 |
片段库不是长时间沉浸阅读,而是快进快出。
布局要服务这个节奏。
四、字段设计要包含语言和场景
4.1 片段匣的核心字段
代码片段如果只存一段code,过几周就很难判断它适用于哪里。
所以字段要把“怎么触发、什么时候用、复制哪一段”说清楚。
| 字段 | 含义 | 页面位置 |
|---|---|---|
| id | 片段唯一标识 | 状态层 |
| title | 片段名称 | 列表 |
| language | 所属语言或技术栈 | 筛选/编辑区 |
| trigger | 常用触发词或使用场景 | 列表/编辑区 |
| code | 可复制的代码正文 | 预览/编辑区 |
| usage | 使用说明和注意点 | 侧栏/导出 |
4.2 TypeScript 类型
exportinterfaceAppItem{id:string;title:string;language:string;trigger:number|string;code:string;usage:string;}exporttypeAppFilter='all'|'active'|'archived';这段类型保持得很直白,是为了让复制和搜索逻辑少绕弯。
片段工具的复杂度不该藏在数据结构里。
五、默认片段要像真实积累
5.1 为什么要写种子数据
片段库的默认数据要能像真实积累,而不是像表单演示。
尤其代码字段要写出能复制的内容,否则样式和滚动都测不出来。
我会用下面三个标准看种子片段:
- 标题能说明用途
- 语言和触发词能帮助搜索
- usage 能告诉人复制以后要改哪里
5.2 示例数据
exportconstseedAppItems:AppItem[]=[{id:'pianduan_xia-001',title:'Vue emits 类型声明',language:'TypeScript',trigger:'开发者复用',code:"const emit = defineEmits<{ save: [id: string] }>();",usage:'用于给 Vue 组件事件补类型,复制后把 save 和参数改成业务字段。',},];真实一点的片段还能顺便检查等宽字体、代码换行和复制结果。
六、状态层处理保存和选择
6.1 composable 的职责
useNotes.ts这层我更愿意把它理解成“当前工具的数据服务”。
页面不应该直接处理太多 localStorage、排序和导出拼接。
constSTORAGE_KEY='pianduan-xia';constitems=ref<AppItem[]>(loadItems());constactiveId=ref(items.value[0]?.id??'');functionpersist(){localStorage.setItem(STORAGE_KEY,JSON.stringify(items.value));}functionloadItems(){constraw=localStorage.getItem(STORAGE_KEY);returnraw?JSON.parse(raw):seedAppItems;}6.2 本地存储 key 一定要独立
这里的 key 我会明确写成pianduan-xia。
这样做可以避免不同工具之间互相读到旧数据。
本地数据一旦串了,页面看起来像小问题,实际会让调试和截图都变得很难判断。
七、筛选排序服务高频片段
7.1 computed 更适合承接派生视图
筛选、搜索、排序这些逻辑如果直接写在模板里,很快会让页面变得难读。
我更倾向于让状态层先准备好可展示列表。
constkeyword=ref('');constfilter=ref<'all'|'title'>('all');constvisibleItems=computed(()=>{consttext=keyword.value.trim().toLowerCase();returnitems.value.filter(item=>JSON.stringify(item).toLowerCase().includes(text)).sort((a,b)=>String(b.id).localeCompare(String(a.id)));});7.2 排序服务于场景
代码片段管理器里,排序不是“哪个字段容易写就按哪个排”。
它应该服务用户打开应用时最想看到的那批内容。
- 未处理内容优先出现
- 置顶或高优先级内容靠前
- 最近更新内容不要沉底
八、Vue 页面突出片段列表
8.1 Home.vue 只做编排
我不希望Home.vue变成所有逻辑的大杂烩。
它更适合负责页面骨架和组件之间的数据传递。
<template> <main class="pianduan_xia-page"> <NoteToolbar @create="createItem" @copy="copyCurrent" @export="exportCurrent" /> <section class="workspace"> <NoteSidebar :items="visibleItems" @select="selectItem" /> <NoteEditor :item="currentItem" @update="updateItem" /> </section> </main> </template>8.2 组件之间的边界
| 组件 | 应该知道什么 | 不应该知道什么 |
|---|---|---|
| NoteToolbar | 当前能触发哪些动作 | 具体字段如何存储 |
| NoteSidebar | 列表、筛选、选中项 | 导出 Markdown 细节 |
| NoteEditor | 当前对象字段 | 全局搜索逻辑 |
边界清楚以后,后续改样式和改字段都会轻很多。
九、编辑器要适合代码内容
9.1 不要只留下标题和正文
片段匣如果只保留标题和正文,就会退回普通记事本。
所以编辑器必须把核心字段摆出来。
<script setup lang="ts"> defineProps<{ item: AppItem | null }>(); const emit = defineEmits<{ update: [item: AppItem] }>(); </script> <template> <form v-if="item" class="editor-form"> <input v-model="item.title" /> <textarea v-model="item.code" /> </form> </template>9.2 表单不是越多越好
我会优先放能影响用户判断的字段。
辅助字段可以放到右侧信息区,或者只在导出时使用。
十、工具栏围绕复制和导出
10.1 工具栏放哪些按钮
工具栏最容易变成按钮仓库。
片段匣里我只保留和主流程强相关的动作。
- 新增片段
- 按语言筛选
- 搜索触发词
- 复制代码
- 导出片段
- 维护说明
10.2 复制摘要
functionbuildAppSummary(item:AppItem){return['# 片段匣摘要','- title: '+item.title,'- language: '+item.language,'- trigger: '+item.trigger,'- code: '+item.code,].join('\n');}复制摘要的好处是很实际的。
用户不一定每次都要导出文件,有时只是想把当前内容发到聊天窗口或文档里。
十一、桥接层收住剪贴板动作
11.1 桥接层只暴露稳定动作
页面不应该知道底层是 Electron clipboard,还是 OpenHarmony 侧的能力。
它只需要知道“复制”“导出”“通知”这些动作。
exportfunctionuseNativeBridge(){constapi=window.ohosBridge??window.electronAPI;asyncfunctioncopyText(text:string){if(api?.copyText)returnapi.copyText(text);returnnavigator.clipboard.writeText(text);}asyncfunctionnotify(message:string){if(api?.notify)returnapi.notify(message);}return{copyText,notify};}11.2 为什么要有浏览器兜底
开发阶段经常会直接跑 Vite。
如果没有浏览器兜底,页面调试会被原生环境绑得太死。
十二、导出 Markdown 要保留代码语境
12.1 导出内容要能独立阅读
导出的 Markdown 不能只是把字段拼起来。
它最好离开应用以后也能被看懂。
functionexportAppMarkdown(item:AppItem){return['# 片段匣','','> 由 片段匣 导出。','## title',String(item.title??''),'## language',String(item.language??''),'## trigger',String(item.trigger??''),'## code',String(item.code??''),'## usage',String(item.usage??''),].join('\n');}12.2 导出动作和通知联动
asyncfunctionexportCurrent(){if(!currentItem.value)return;constmarkdown=exportAppMarkdown(currentItem.value);awaitbridge.copyText(markdown);awaitbridge.notify('片段匣内容已复制为 Markdown');}这样用户完成导出以后能马上得到反馈。
十三、主进程加载保证开发时可用
13.1 开发环境和生产环境分开
桌面应用最常见的白屏问题之一,是生产环境还在访问开发服务器。
所以主进程里一定要把加载逻辑分清楚。
constpath=require('path');functionresolveRendererUrl(){if(process.env.VITE_DEV_SERVER_URL){returnprocess.env.VITE_DEV_SERVER_URL;}return`file://${path.join(__dirname,'../dist/index.html')}`;}mainWindow.loadURL(resolveRendererUrl());13.2 preload 只注入必要接口
const{contextBridge,ipcRenderer}=require('electron');contextBridge.exposeInMainWorld('electronAPI',{copyText:text=>ipcRenderer.invoke('copy-text',text),notify:message=>ipcRenderer.invoke('notify',message),});接口少一点,维护起来更安心。
十四、片段库样式要利于阅读代码
14.1 视觉气质服务使用场景
片段匣的视觉方向是:开发者工具感、信息密度高、代码可读。
这个判断会影响间距、字号、卡片密度和按钮重量。
.pianduan_xia-page{min-height:100vh;display:flex;flex-direction:column;background:#f7f8fb;color:#1f2937;}.workspace{display:grid;grid-template-columns:280pxminmax(0,1fr);gap:16px;min-height:0;}14.2 滚动区要提前处理
桌面应用窗口经常被用户缩小。
如果滚动区没有处理好,内容一多就会挤成一团。
- 左侧列表要能独立滚动
- 编辑区不能把工具栏挤出屏幕
- 右侧信息区要允许内容截断和换行
十五、构建后检查片段主题
15.1 先确认前端产物能生成
写文章之前,我会先跑一次构建。
这一步很朴素,但能挡住不少低级问题。
cd../../electron_for_harmony/electron-openharmony-vue3-13/ohos_hap/web_engine/src/main/resources/resfile/resources/app/vue-appnpminstallnpmrun build15.2 再确认关键文件没有串主题
rg"pianduan-xia|/snippets|片段匣"src package.json rg"TODO|旧标题|测试数据"src构建通过不代表体验完美,但至少说明当前页面和依赖关系是站得住的。
十六、这版片库的经验
16.1 先换问题,再换界面
片段匣最重要的不是页面长什么样,而是它先回答了一个明确问题:常用代码如果散在各个项目里,真正要复用时反而找不到。片段工具要解决快找、快看、快复制。
问题清楚以后,字段、布局和按钮才知道往哪里收。
16.2 哪些东西可以复用
- 清晰的页面、状态层、桥接层分工
- 状态层和本地存储节奏
- 复制、导出、通知这组桌面动作
- 开发环境与生产环境分开的加载逻辑
16.3 哪些东西不要硬套
- 旧的数据字段
- 旧的默认文案
- 旧的视觉重心
- 旧的排序规则
十七、后续可以补的开发能力
片段匣目前已经能支撑个人片段的收集、查找和复制。
真要继续加功能,我会优先从这些方向补:
- 增加语言和框架的组合筛选
- 支持代码高亮主题切换
- 增加复制次数统计,让高频片段自动浮上来
- 支持片段变量占位,比如组件名、接口名
- 给片段增加失效标记,避免复制旧写法
片段库后续最值得补的是“更快找到”和“更放心复制”。
十八、发布前做一次片段检查
发布前我会按下面这张表再扫一遍,尤其确认主题一致性和可发布性。
| 检查项 | 结果 | 说明 |
|---|---|---|
| 标题和主题一致 | 通过 | 片段匣实战:给常用代码片段一个能搜索、复制和整理的桌面仓 |
| 图片存在 | 通过 | 保留项目结构图或运行效果图 |
| 代码块数量 | 通过 | 覆盖类型、状态、组件、桥接、导出、构建 |
| 资源链接 | 通过 | 保留社区和官方文档入口 |
总结
片段匣这版的核心价值,是把代码片段管理器从一个想法落成了一个能操作、能保存、能复制、能导出的桌面工具。
片段匣的价值在“下一次少翻一个项目”。
只要搜索、预览和复制足够顺,它就能成为开发者日常工作里很轻的一层辅助,而不是另一个需要维护的知识库。
如果这篇文章对你有帮助,欢迎点赞👍、收藏⭐、关注🔔,你的支持是我持续创作的动力!
相关资源:
- 鸿蒙PC开发者社区:https://harmonypc.csdn.net/
- OpenHarmony 官网:https://www.openharmony.cn/
