Swift Публичные протоколы с внутренними функциями и свойствами

Question

Мне интересно, что такое лучшая практика, когда я хочу, чтобы некоторые функции были общедоступными, а некоторые - внутренними при работе с протоколами.

Я пишу AudioManager в Swift 3 упаковка AVPlayer в качестве рамки.

Я хочу, чтобы некоторые методы были общедоступными, так что, например, ViewController, использующий AudioManager, может получить доступ к некоторым методам, но некоторые методы не будут отображаться вне рамки
-> то есть иметь модификатор доступа internal вместо public.

Я пишу фреймворк с поддержкой протокола, почти каждая часть должна иметь протокол.
Итак, протоколы говорят о протоколах в рамках.
. основной класс - AudioManager - имеет AudioPlayer и должен иметь возможность называть некоторые функции internal,
, например. pause(reason:), но этот метод должен быть internal и не выставлен снаружи рамки.

Вот пример.

internal enum PauseReason { 
    case byUser 
    case routeChange 
} 

// Compilation error: `Public protocol cannot refine an internal protocol` 
public protocol AudioPlayerProtocol: InternalAudioPlayerProtocol { 
    func pause() // I want 
} 

internal protocol InternalAudioPlayerProtocol { 
    func pause(reason: PauseReason) // Should only be accessible within the framework 
} 

public class AudioPlayer: AudioPlayerProtocol { 
    public func pause() { 
     pause(reason: .byUser) 
    } 

    // This would probably not compile because it is inside a public class... 
    internal func pause(reason: PauseReason) { //I want this to be internal 
     // save reason and to stuff with it later on 
    } 
} 

public protocol AudioManagerProtocol { 
    var audioPlayer: AudioPlayerProtocol { get } 
} 

public class AudioManager: AudioManagerProtocol { 
    public let audioPlayer: AudioPlayerProtocol 

    init() { 
     audioPlayer = AudioPlayer() 
     NotificationCenter.default.addObserver(self, selector: #selector(handleRouteChange(_:)), name: NSNotification.Name.AVAudioSessionRouteChange, object: nil) 
    } 

    func handleRouteChange(_ notification: Notification) { 
     guard 
     let userInfo = notification.userInfo, 
     let reasonRaw = userInfo[AVAudioSessionRouteChangeReasonKey] as? NSNumber, 
     let reason = AVAudioSessionRouteChangeReason(rawValue: reasonRaw.uintValue) 
     else { print("what could not get route change") } 
     switch reason { 
     case .oldDeviceUnavailable: 
      pauseBecauseOfRouteChange() 
     default: 
      break 
     } 
    } 
} 

private extension AudioManager { 
    func pauseBecauseOfRouteChange() { 
     audioPlayer.pause(reason: .routeChange) 
    } 
} 

// Outside of Audio framework 
class PlayerViewController: UIViewController { 
    fileprivate let audioManager: AudioManagerProtocol 
    @IBAction didPressPauseButton(_ sender: UIButton) { 
     // I want the `user of the Audio framwwork` (in this case a ViewController) 
     // to only be able to `see` `pause()` and not `pause(reason:)` 
     audioManager.audioPlayer.pause() 
    } 
} 

Я знаю, что могу заставить его работать, изменяя метод pauseBecauseOfRouteChange выглядеть следующим образом:

func pauseBecauseOfRouteChange() { 
    guard let internalPlayer = audioPlayer as? InternalAudioPlayerProtocol else { return } 
    internalPlayer.pause(reason: .routeChange) 
} 

Но мне интересно, если есть более элегантное решение?
Что-то вроде маркировки, что AudioPlayerProtocol измельчает InternalAudioPlayerProtocol ...

Или как ты молодец программисты делают это?
Рамка более красива, если она не раскрывает методы и переменные, предназначенные для внутреннего использования!

Спасибо! не

Answer 1

Нет, нет более элегантное решение этой проблемы, по крайней мере, при рассмотрении протоколов, и вот почему:

Представьте себе ситуацию, что кто-то с помощью рамки хочет написать расширение для AudioPlayerProtocol, как тогда pause(reason:) метод может быть реализован, если он является внутренним?

Вы можете достичь его, просто подклассов и этот код на самом деле будет компилировать:

public class AudioPlayer: AudioPlayerProtocol { 
    public func pause() { 
     pause(reason: .byUser) 
    } 

    internal func pause(reason: PauseReason) { 
    } 
} 

С протоколами это не так, потому что вы просто не может гарантировать выполнение внутренней функции, если кто-то с уровнем общественного доступа хочет используйте свой смешанный общедоступный/внутренний протокол.

Answer 2

Как разбить ваш протокол на внутренний и общедоступный, а затем разрешить публичному классу реализации делегировать его во внутреннюю реализацию. Например:

internal protocol InternalAudioPlayerProtocol { 
    func pause(reason: PauseReason) 
} 

public protocol AudioPlayerProtocol { 
    func pause() 
} 

internal class InternalAudioPlayer: InternalAudioPlayerProtocol { 
    internal func pause(reason: PauseReason) { 
    } 
} 

public class AudioPlayer: AudioPlayerProtocol { 
    internal var base: InternalAudioPlayerProtocol 

    internal init(base: InternalAudioPlayerProtocol) { 
     self.base = base 
    } 

    public func pause() { 
     base.pause(reason: .byUser) 
    } 
} 

public protocol AudioManagerProtocol { 
    var audioPlayer: AudioPlayerProtocol { get } 
} 

public class AudioManager: AudioManagerProtocol { 
    internal let base = InternalAudioPlayer() 
    public let audioPlayer: AudioPlayerProtocol 

    public init() { 
     audioPlayer = AudioPlayer(base: base) 
    } 

    internal func handleSomeNotification() {    
     pauseBecauseOfRouteChange() //amongst other things 
    } 

    internal func pauseBecauseOfRouteChange() { 
     base.pause(reason: .routeChange) 
    } 
}