鸿蒙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;}exporttypeAppFilterall|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_KEYpianduan-xia;constitemsrefAppItem[](loadItems());constactiveIdref(items.value[0]?.id??);functionpersist(){localStorage.setItem(STORAGE_KEY,JSON.stringify(items.value));}functionloadItems(){constrawlocalStorage.getItem(STORAGE_KEY);returnraw?JSON.parse(raw):seedAppItems;}6.2 本地存储 key 一定要独立这里的 key 我会明确写成pianduan-xia。这样做可以避免不同工具之间互相读到旧数据。本地数据一旦串了页面看起来像小问题实际会让调试和截图都变得很难判断。七、筛选排序服务高频片段7.1 computed 更适合承接派生视图筛选、搜索、排序这些逻辑如果直接写在模板里很快会让页面变得难读。我更倾向于让状态层先准备好可展示列表。constkeywordref();constfilterrefall|title(all);constvisibleItemscomputed((){consttextkeyword.value.trim().toLowerCase();returnitems.value.filter(itemJSON.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 classpianduan_xia-page NoteToolbar createcreateItem copycopyCurrent exportexportCurrent / section classworkspace NoteSidebar :itemsvisibleItems selectselectItem / NoteEditor :itemcurrentItem updateupdateItem / /section /main /template8.2 组件之间的边界组件应该知道什么不应该知道什么NoteToolbar当前能触发哪些动作具体字段如何存储NoteSidebar列表、筛选、选中项导出 Markdown 细节NoteEditor当前对象字段全局搜索逻辑边界清楚以后后续改样式和改字段都会轻很多。九、编辑器要适合代码内容9.1 不要只留下标题和正文片段匣如果只保留标题和正文就会退回普通记事本。所以编辑器必须把核心字段摆出来。script setup langts defineProps{ item: AppItem | null }(); const emit defineEmits{ update: [item: AppItem] }(); /script template form v-ifitem classeditor-form input v-modelitem.title / textarea v-modelitem.code / /form /template9.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(){constapiwindow.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;constmarkdownexportAppMarkdown(currentItem.value);awaitbridge.copyText(markdown);awaitbridge.notify(片段匣内容已复制为 Markdown);}这样用户完成导出以后能马上得到反馈。十三、主进程加载保证开发时可用13.1 开发环境和生产环境分开桌面应用最常见的白屏问题之一是生产环境还在访问开发服务器。所以主进程里一定要把加载逻辑分清楚。constpathrequire(path);functionresolveRendererUrl(){if(process.env.VITE_DEV_SERVER_URL){returnprocess.env.VITE_DEV_SERVER_URL;}returnfile://${path.join(__dirname,../dist/index.html)};}mainWindow.loadURL(resolveRendererUrl());13.2 preload 只注入必要接口const{contextBridge,ipcRenderer}require(electron);contextBridge.exposeInMainWorld(electronAPI,{copyText:textipcRenderer.invoke(copy-text,text),notify:messageipcRenderer.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 再确认关键文件没有串主题rgpianduan-xia|/snippets|片段匣src package.json rgTODO|旧标题|测试数据src构建通过不代表体验完美但至少说明当前页面和依赖关系是站得住的。十六、这版片库的经验16.1 先换问题再换界面片段匣最重要的不是页面长什么样而是它先回答了一个明确问题常用代码如果散在各个项目里真正要复用时反而找不到。片段工具要解决快找、快看、快复制。问题清楚以后字段、布局和按钮才知道往哪里收。16.2 哪些东西可以复用清晰的页面、状态层、桥接层分工状态层和本地存储节奏复制、导出、通知这组桌面动作开发环境与生产环境分开的加载逻辑16.3 哪些东西不要硬套旧的数据字段旧的默认文案旧的视觉重心旧的排序规则十七、后续可以补的开发能力片段匣目前已经能支撑个人片段的收集、查找和复制。真要继续加功能我会优先从这些方向补增加语言和框架的组合筛选支持代码高亮主题切换增加复制次数统计让高频片段自动浮上来支持片段变量占位比如组件名、接口名给片段增加失效标记避免复制旧写法片段库后续最值得补的是“更快找到”和“更放心复制”。十八、发布前做一次片段检查发布前我会按下面这张表再扫一遍尤其确认主题一致性和可发布性。检查项结果说明标题和主题一致通过片段匣实战给常用代码片段一个能搜索、复制和整理的桌面仓图片存在通过保留项目结构图或运行效果图代码块数量通过覆盖类型、状态、组件、桥接、导出、构建资源链接通过保留社区和官方文档入口总结片段匣这版的核心价值是把代码片段管理器从一个想法落成了一个能操作、能保存、能复制、能导出的桌面工具。片段匣的价值在“下一次少翻一个项目”。只要搜索、预览和复制足够顺它就能成为开发者日常工作里很轻的一层辅助而不是另一个需要维护的知识库。如果这篇文章对你有帮助欢迎点赞、收藏⭐、关注你的支持是我持续创作的动力相关资源鸿蒙PC开发者社区https://harmonypc.csdn.net/OpenHarmony 官网https://www.openharmony.cn/