Xcode插件开发
创始人
2024-09-25 07:48:17
0

Xcode插件开发

文章目录

  • Xcode插件开发
    • 一、插件开发流程
      • 创建插件
      • Extension文件介绍
      • 文件说明
    • 二、插件使用安装说明

一、插件开发流程

创建插件的过程并不复杂,只是官方教程,过于简单,所以这里补充下创建细节

创建插件

环境:Xcode 15.2
先创建一个Mac App
选择 Xcode - File - New - Project,选择macOS - App - Next,跟创建iOS App类似
在这里插入图片描述

然后Target里添加一个Extension
选择 Xcode - File - New - Target,选择macOS - Xcode Source Editor Extension
在这里插入图片描述

创建后文件目录
在这里插入图片描述

这里可能需要重新引用下,否则在Xcode中,会找不到该插件
选择Targets - TestDemoExtension - General - Frameworks and Libraries,添加XcodeKit,并将XcodeKit修改为Embed&Sign
在这里插入图片描述

这样一个Xcode插件就创建完成了,这时我们没有修改任何代码,直接选择Extension然后运行,就会出现一个重新启动一个新的Xcode(在Xcode15之前是显示为灰色图标的,Xcode15之后是带颜色的,如下图),是作为调试的Xcode,使用该Xcode打开的Project,在菜单栏的Editor,就会出现我们开发的插件了
在这里插入图片描述

在这里插入图片描述

选中Project中的任意一个.swift文件或者.h/.m文件,Editor - TestDemoExtension - Source Editor Command
在这里插入图片描述

Extension文件介绍

上面运行后能看到插件的名称以及默认选项,是因为创建Extension时,会自动创建一个默认的选项,在Info.plist文件中,我们可以根据自己的业务需要修改,或者添加其他的定义

添加或修改插件的菜单名称和命令,有两种方式:
第一种:直接在Info.plist文件中添加或修改
在这里插入图片描述

XCSourceEditorCommandClassName:处理此菜单的类名
XCSourceEditorCommandIdentifier:此菜单的标识,可以在处理类中用户判断点击了哪一个菜单(如果有多个的情况)
XCSourceEditorCommandName:菜单的名称

运行结果:
在这里插入图片描述

第二种:修改SourceEditorExtension.swift代码文件添加或修改
在这里插入图片描述

nameKey: 菜单的名称
identifierKey:菜单的标识,可以在处理类中用于判断点击了哪一个菜单(如果有多个的情况)
classNameKey:处理此菜单的类名,这里我们直接使用className()获取,如果你直接写字符串记得在类名前加上模块名

运行结果:
在这里插入图片描述

可以看到经过上面的验证,SourceEditorExtension.swift文件中的返回值优先级高于info.plist文件,实际情况中我们使用一种设置即可。

文件说明

  • SourceEditorExtension:设置插件的菜单键以及对应的配置信息,包括菜单的名称、菜单的唯一标识以及菜单的处理类
  • SourceEditorCommand:就是对应菜单的处理类,需要遵守XCSourceEditorCommand协议,并且实现以下方法,用作点击菜单的具体处理逻辑:
class SourceEditorCommand: NSObject, XCSourceEditorCommand {          func perform(with invocation: XCSourceEditorCommandInvocation, completionHandler: @escaping (Error?) -> Void ) -> Void {         // Implement your command here, invoking the completion handler when done. Pass it nil on success, and an NSError on failure.                  completionHandler(nil)     }      } 

如果有多个菜单,为了独立开来,可以自行创建一个处理类,比如,上面添加的三个菜单都是引用同一个处理类,那么代码会集中在同一个文件,为了区分,为菜单2创建单独的处理类Menu2Command.swift,代码如下

import Foundation import XcodeKit  class Menu2Command: NSObject, XCSourceEditorCommand {          func perform(with invocation: XCSourceEditorCommandInvocation, completionHandler: @escaping (Error?) -> Void ) -> Void {         // Implement your command here, invoking the completion handler when done. Pass it nil on success, and an NSError on failure.                  print("点击菜单2")         completionHandler(nil)     }      } 

运行结果,分别点击菜单2、菜单1、菜单3,打印结果:
在这里插入图片描述

  • Info.plist:插件菜单的管理类,可以直接在Info中添加,在上面也有介绍

二、插件使用安装说明

1、选择Mac App,然后Xcode - product - Archive,然后导出ipa包,导出方式跟iOS App类似,这里如果不发布的话,可以直接选择Debuging
在这里插入图片描述

2、导出后,将ipa包直接拖入应用程序中,并且首次需要打开一下,然后在Mac 设置 - 隐私与安全性 - 扩展 - Xcode Source Editor 中就可以看到此插件的名称
在这里插入图片描述
在这里插入图片描述

勾选所需要的插件,默认应该是勾选
在这里插入图片描述
3、然后重新启动正版的Xcode,选择Editor,便可以看到所安装的插件了
在这里插入图片描述

相关内容

热门资讯

阿里云空间怎么设置(如何设置阿... 什么是阿里云对象存储?阿里云对象存储(Object Storage Service,简称OSS)是阿...
阿里云空间怎么样(阿里云存储空... 阿里云空间怎么样?评价阿里云存储空间的特点阿里云是的一家云计算服务提供商,其提供了各种云计算服务,包...
阿里云网站建设怎么样(阿里云如... 阿里云网站建设的重要性随着互联网的快速发展,网站成为企业展示和营销的重要手段。对于阿里云这样的云计算...
阿里云网站备案号怎么显示(如何... 阿里云网站备案号怎么显示在进行网站备案过程中,阿里云向在其平台上进行备案的用户提供了一个备案号,用来...
阿里云空间流量怎么算(如何计算... 阿里云空间流量怎么算(如何计算阿里云对象存储的流量)阿里云对象存储(Object Storage S...
阿里云网盘怎么下载电影(如何在... 阿里云网盘怎么下载电影阿里云网盘是一款备受欢迎的云存储服务,它可以方便地存储和共享文件。另外,阿里云...
阿里云国际怎么支付方式(阿里云... 阿里云国际怎么支付方式?作为全球最大的云计算及人工智能科技公司之一,阿里云国际已经在全球范围内展开业...
阿里云的域名怎么备案(如何备案... 阿里云的域名备案流程阿里云作为国内知名的云服务商,有着众多用户和客户。在使用阿里云主机、虚拟主机、云...
阿里云的空间怎么样(阿里云空间... 阿里云空间的性能如何?作为一家云计算领域的龙头企业,阿里云早已经在云空间领域拥有了深厚的技术积累和雄...
阿里云空间信息怎么倒出(阿里云... 介绍阿里云是最大的云服务提供商之一。作为一家全球性的云计算企业,阿里云将强大的云计算能力、先进的计算...