启动时XPC Service连接立即失效问题排查求助

开发环境 #

• Xcode版本：14.3.1
• macOS Ventura版本：13.6.2
• 架构：Intel

问题描述 #

开发带XPC Service的macOS应用时，启动阶段XPC连接直接失效，收到错误：

Error Domain=NSCocoaErrorDomain Code=4099 "The connection to service named com.appname.macos.app-name-xpc was invalidated." UserInfo={NSDebugDescription=The connection to service named com.appname.macos.app-name-xpc was invalidated: failed at lookup with error 3 - No such process.}

已完成的验证 #

• XPC Service的CFBundleIdentifier正确，且位于应用bundle的Contents/XPCServices目录下
• XPC Service的Info.plist中ServiceType已设置为Bundled
• XPC组件的安装目录为Content/XPCServices（注：此处疑似笔误，应为Contents/XPCServices）
• 已验证主应用和XPC Service的代码签名与权限，临时禁用沙箱无法解决问题
• 主应用与XPC Service属于同一App Group，且均开启App Sandbox

相关代码 #

XPC连接代码 #

let xpcConnection = NSXPCConnection(serviceName: "com.appname.macos.app-name-xpc")
xpcConnection.remoteObjectInterface = NSXPCInterface(with: ServiceProtocol.self)
xpcConnection.resume()

ServiceProtocol定义 #

@objc public protocol ServiceProtocol: NSObjectProtocol {
    @objc func executeUnixExecutable(arguments: [String], completionHandler: @escaping (ResultType) -> Void)
    
    func interruptUnixExecutable()
    func closeUnixExecutablePipes()
}

排查建议 #

• 检查XPC Service的Info.plist关键配置
  除ServiceType外，确认：

  • NSPrincipalClass是否正确指向XPC Service的主类，格式应为$(PRODUCT_MODULE_NAME).[你的代理类名]
  • CFBundleExecutable是否与XPC target的产品名称一致，确保编译后生成了对应的可执行文件

• 修正XPC安装目录的笔误与打包配置
  你提到的Content/XPCServices应为Contents/XPCServices（注意复数），并验证：

  • XPC target的Build Settings中，Installation Directory设置为$(CONTENTS_FOLDER_PATH)/XPCServices
  • 主应用的Build Phases中，添加的Copy Files阶段需将Destination设为Wrapper，Subpath设为Contents/XPCServices，并正确添加XPC Service target
  • 右键运行后的.app选择「显示包内容」，确认Contents/XPCServices下的XPC bundle内，Contents/MacOS/目录存在对应可执行文件

• 验证XPC Service的启动逻辑
  确保XPC Service的主类正确实现NSXPCListenerDelegate，且main函数启动RunLoop：

  import Foundation
  
  class XPCServiceDelegate: NSObject, NSXPCListenerDelegate, ServiceProtocol {
      // 实现ServiceProtocol的方法
      func executeUnixExecutable(arguments: [String], completionHandler: @escaping (ResultType) -> Void) {
          // 业务逻辑
      }
      
      func interruptUnixExecutable() {}
      func closeUnixExecutablePipes() {}
      
      // 实现listener代理方法
      func listener(_ listener: NSXPCListener, shouldAcceptNewConnection newConnection: NSXPCConnection) -> Bool {
          newConnection.exportedInterface = NSXPCInterface(with: ServiceProtocol.self)
          newConnection.exportedObject = self
          newConnection.resume()
          return true
      }
  }
  
  // main函数启动监听
  let delegate = XPCServiceDelegate()
  let listener = NSXPCListener.service()
  listener.delegate = delegate
  listener.resume()
  RunLoop.main.run()
  

  注意：XPC Service的main函数不能提前退出，必须通过RunLoop.main.run()保持进程存活

• 代码签名与权限细节检查

  • 确保主应用与XPC Service使用同一签名身份（如Apple Development、Developer ID）
  • 若XPC需要执行外部Unix可执行文件，可在XPC的Entitlements中添加com.apple.security.cs.disable-library-validation和com.apple.security.cs.allow-unsigned-executable-memory权限（调试阶段可临时开启）

• 直接调试XPC Service

  • 在Xcode中切换到XPC Service的target，直接运行，查看是否有崩溃日志或启动失败提示
  • 为主应用和XPC Service添加断点，重点检查XPC连接建立、listener的shouldAcceptNewConnection回调是否被触发

• 再次核对Bundle Identifier
  确认代码中NSXPCConnection(serviceName:)的字符串与XPC Service的CFBundleIdentifier完全一致，包括大小写与标点

内容的提问来源于stack exchange，提问作者ballade4op52