SwiftUI之ScrollView+Hosting+Representable

本篇文章主要內容是Hosting+Representable,但我們首先會講解一下在iOS14中,ScrollView新增的一個功能。

ScrollViewProxy & ScrollViewReader

在iOS14中,ScrollView新增了一個ScrollViewProxy和ScrollViewReader。

public struct ScrollViewProxy {
    public func scrollTo<ID>(_ id: ID, anchor: UnitPoint? = nil) where ID : Hashable
}
@frozen public struct ScrollViewReader<Content> : View where Content : View {

    public var content: (ScrollViewProxy) -> Content

    @inlinable public init(@ViewBuilder content: @escaping (ScrollViewProxy) -> Content)

    /// The content and behavior of the view.
    public var body: some View { get }

    public typealias Body = some View
}
  • ScrollViewReader需要寫在ScrollView內部,其目的是獲取ScrollViewProxy
  • ScrollViewProxy中有一個方法,能夠讓ScrollView滾動到某個id的位置
image

仔細觀察上圖,可以發現,點擊最左邊的按鈕,確實能夠讓ScrollView滾動到某個指定的位置,scrollTo<ID>(_ id: ID, anchor: UnitPoint? = nil) where ID : Hashable函數中,有一個參數叫anchor,當其值為nil時,系統會自動計算出滾動到該位置最短的距離,當不為nil時區別是:

  • leading 表示滾動到與ScrollView左對齊
  • .center表示滾動到ScrollView的中間
  • .trailing表示滾動到與ScrollView右對齊

用起來非常簡單,但是值得注意的是,按鈕必須在ScrollView中才行。代碼如下:

struct Example1: View {
    var body: some View {
        ScrollView(.horizontal) {
            ScrollViewReader { scrollViewProxy in
                
                LazyHStack(spacing: 10) {
                    ...
                    
                    ForEach(0..<20) { index in
                        Text("\(index)")
                            .frame(width: 100, height: 240)
                            
                            .background(index == 6 ? Color.green : Color.orange.opacity(0.5))
                            .cornerRadius(3.0)
                    }
                }
                .padding(.horizontal, 10)
            }
        }
        .frame(height: 300, alignment:  .center)
    }
}

ScrollViewRepresentable

上邊提到的新增的這個功能只能算是一個非常小的功能,在UIKit中,ScrollView有十分豐富的功能,我們知道,通過ScrollViewRepresentable可以讓我們直接使用UIKit中的View,代碼類似于:

struct Example2: View {
    var body: some View {
        ScrollViewRepresentable()
            .frame(width: 200, height: 100)
    }
    
    struct ScrollViewRepresentable: UIViewRepresentable {
        func makeUIView(context: Context) -> UIScrollView {
            let scrollView = UIScrollView()
            scrollView.backgroundColor = UIColor.green
            return scrollView
        }
        
        func updateUIView(_ uiView: UIScrollView, context: Context) {}
    }
}

在這種情況下,只能讓我們訪問到UIScrollView,但是如果在其上邊添加SwiftUI中的View就做不到了。因此這種方案pass掉。

Hosting+Representable

所謂的Hosting指的是UIHostingController<Content>,而Representable則指的是UIViewControllerRepresentable,只需把這兩者結合起來,能夠獲取強大的能力。

那么UIHostingController是什么呢?先給大家看一張圖:

image

很明顯,它就是SwiftUI和UIKit中的一個橋梁,系統會把SwiftUI中的View翻譯成UIKit中的View。我們最終的目的是實現下邊兩張圖的效果:

  • 監聽當前滾動的offset
  • 滾動到指定的offset處
image
image
class MyScrollViewUIHostingController<Content>: UIHostingController<Content> where Content: View {
    var offset: Binding<CGFloat>
    let isOffsetX: Bool
    var showed = false
    var sv: UIScrollView?
    
    init(offset: Binding<CGFloat>, isOffsetX: Bool,  rootView: Content) {
        self.offset = offset
        self.isOffsetX = isOffsetX
        super.init(rootView: rootView)
    }
    
    @objc dynamic required init?(coder aDecoder: NSCoder) {
        fatalError("init(coder:) has not been implemented")
    }
    
    override func viewDidAppear(_ animated: Bool) {
        /// 保證設置一次監聽
        if showed {
            return
        }
        showed = true
        
        /// 查找UIScrollView
        sv = findScrollView(in: view)
        
        /// 設置監聽
        sv?.addObserver(self,
                        forKeyPath: #keyPath(UIScrollView.contentOffset),
                        options: [.old, .new],
                        context: nil)
        
        /// 滾動到指定位置
        scroll(to: offset.wrappedValue, animated: false)
        
        super.viewDidAppear(animated)
    }
    
    func scroll(to position: CGFloat, animated: Bool = true) {
        if let s = sv {
            if position != (self.isOffsetX ? s.contentOffset.x : s.contentOffset.y) {
                let offset = self.isOffsetX ? CGPoint(x: position, y: 0) : CGPoint(x: 0, y: position)
                sv?.setContentOffset(offset, animated: animated)
            }
        }
    }
    
    override func observeValue(forKeyPath keyPath: String?,
                               of object: Any?,
                               change: [NSKeyValueChangeKey: Any]?,
                               context: UnsafeMutableRawPointer?) {
        if keyPath == #keyPath(UIScrollView.contentOffset) {
            if let s = self.sv {
                DispatchQueue.main.async {
                    self.offset.wrappedValue = self.isOffsetX ? s.contentOffset.x : s.contentOffset.y
                }
            }
        }
    }
    
    func findScrollView(in view: UIView?) -> UIScrollView? {
        if view?.isKind(of: UIScrollView.self) ?? false {
            return view as? UIScrollView
        }
        
        for subview in view?.subviews ?? [] {
            if let sv = findScrollView(in: subview) {
                return sv
            }
        }
        
        return nil
    }
}

MyScrollViewUIHostingController中,可以直接訪問到UIScrollView,并且把傳過來的Content設置為rootView,上邊這段代碼還是非常簡單的。

struct MyScrollViewControllerRepresentable<Content>: UIViewControllerRepresentable where Content: View {
    var offset: Binding<CGFloat>
    let isOffsetX: Bool
    var content: Content
    
    func makeUIViewController(context: Context) -> MyScrollViewUIHostingController<Content> {
        MyScrollViewUIHostingController(offset: offset, isOffsetX:isOffsetX, rootView: content)
    }
    
    func updateUIViewController(_ uiViewController: MyScrollViewUIHostingController<Content>, context: Context) {
        uiViewController.scroll(to: offset.wrappedValue, animated: true)
    }
}

MyScrollViewControllerRepresentable實現了UIViewControllerRepresentable協議,因此可以直接在SwiftUI的View中創建。

extension View {
    func scrollOffsetX(_ offsetX: Binding<CGFloat>) -> some View {
        return MyScrollViewControllerRepresentable(offset: offsetX, isOffsetX: true, content: self)
    }
}

extension View {
    func scrollOffsetY(_ offsetY: Binding<CGFloat>) -> some View {
        return MyScrollViewControllerRepresentable(offset: offsetY, isOffsetX: false, content: self)
    }
}

最后,我們創建了兩個View的extension,像下邊的代碼一樣使用:

ScrollView(.horizontal) {
    ...
}
.scrollOffsetX(self.$offsetX)
ScrollView(.vertical) {
    ...
.scrollOffsetY(self.$offsetY)

總結

當我們遇到SwiftUI提供的功能不夠用的時候,我們可以考慮上邊用到的這種解決方案,能夠為我們提供一個不錯的思路。

我已經把該功能單獨地抽離出來了,代碼倉庫地址為https://github.com/agelessman/SwiftUI_ScrollView_Offset

本篇文章的示例代碼在此處可以訪問:https://gist.github.com/agelessman/3bf1d4f4d7fb24495972ba962777874f

SwiftUI集合:FuckingSwiftUI

?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 228,412評論 6 532
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,514評論 3 416
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 176,373評論 0 374
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,975評論 1 312
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,743評論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,199評論 1 324
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,262評論 3 441
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,414評論 0 288
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,951評論 1 336
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,780評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,983評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,527評論 5 359
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,218評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,649評論 0 26
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,889評論 1 286
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,673評論 3 391
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,967評論 2 374