Swift(UI)中的some关键字是什么?


259

新的SwiftUI教程具有以下代码:

struct ContentView: View {
    var body: some View {
        Text("Hello World")
    }
}

第二行单词some和在其网站上被高亮显示,就好像它是关键字一样。

Swift 5.1似乎没有some作为关键字,而且我也看不出该词some还有什么其他用处,因为它通常位于类型所在的位置。是否有Swift的未发布新版本?它是以我不知道的方式在类型上使用的函数吗?

关键字有some什么作用?


对于那些对这个主题感到头晕的人,这里要感谢Vadim Bulavin,这是一篇非常解密和循序渐进的文章。 vadimbulavin.com/...
吕克-奥利维尔

Answers:


333

some ViewSE-0244引入的不透明结果类型,在带有Xcode 11的Swift 5.1中可用。您可以将其视为“反向”通用占位符。

与调用方可以满足的常规通用占位符不同:

protocol P {}
struct S1 : P {}
struct S2 : P {}

func foo<T : P>(_ x: T) {}
foo(S1()) // Caller chooses T == S1.
foo(S2()) // Caller chooses T == S2.

不透明的结果类型是实现满足的隐式通用占位符,因此您可以考虑一下:

func bar() -> some P {
  return S1() // Implementation chooses S1 for the opaque result.
}

看起来像这样:

func bar() -> <Output : P> Output {
  return S1() // Implementation chooses Output == S1.
}

实际上,此功能的最终目标是允许以更明确的形式使用反向泛型,这也将使您添加约束,例如-> <T : Collection> T where T.Element == Int有关更多信息,请参见此帖子

要摆脱的主要问题是,函数返回some P是一个函数,该函数返回符合的特定单个具体类型的值P。尝试在函数中返回不同的符合类型会产生编译器错误:

// error: Function declares an opaque return type, but the return
// statements in its body do not have matching underlying types.
func bar(_ x: Int) -> some P {
  if x > 10 {
    return S1()
  } else {
    return S2()
  }
}

因为隐式通用占位符不能由多种类型满足。

这与returning函数相反P,后者可以用来表示两者, S1并且S2因为它表示任意P符合的值:

func baz(_ x: Int) -> P {
  if x > 10 {
    return S1()
  } else {
    return S2()
  }
}

好的,不透明结果类型-> some P比协议返回类型有什么好处-> P


1.不透明的结果类型可以与PAT一起使用

当前协议的主要限制是PAT(具有关联类型的协议)不能用作实际类型。尽管此限制在将来的语言版本中可能会取消,但由于不透明的结果类型实际上只是通用的占位符,因此它们现在可以与PATs一起使用。

这意味着您可以执行以下操作:

func giveMeACollection() -> some Collection {
  return [1, 2, 3]
}

let collection = giveMeACollection()
print(collection.count) // 3

2.不透明的结果类型具有标识

由于不透明的结果类型强制返回单个具体类型,因此编译器知道两次调用同一函数必须返回两个相同类型的值。

这意味着您可以执行以下操作:

//   foo() -> <Output : Equatable> Output {
func foo() -> some Equatable { 
  return 5 // The opaque result type is inferred to be Int.
}

let x = foo()
let y = foo()
print(x == y) // Legal both x and y have the return type of foo.

这是合法的,因为编译器知道两者x并且y具有相同的具体类型。这是==两个参数类型都为的重要要求Self

protocol Equatable {
  static func == (lhs: Self, rhs: Self) -> Bool
}

这意味着它期望两个值都与具体符合类型相同。即使Equatable可用作类型,您也无法将两个任意Equatable符合的值相互比较,例如:

func foo(_ x: Int) -> Equatable { // Assume this is legal.
  if x > 10 {
    return 0
  } else {
    return "hello world"      
  }
}

let x = foo(20)
let y = foo(5)
print(x == y) // Illegal.

由于编译器无法证明两个任意Equatable值具有相同的基础具体类型。

以类似的方式,如果我们引入了另一个不透明类型返回函数:

//   foo() -> <Output1 : Equatable> Output1 {
func foo() -> some Equatable { 
  return 5 // The opaque result type is inferred to be Int.
}

//   bar() -> <Output2 : Equatable> Output2 {
func bar() -> some Equatable { 
  return "" // The opaque result type is inferred to be String.
}

let x = foo()
let y = bar()
print(x == y) // Illegal, the return type of foo != return type of bar.

这个例子,因为虽然两者成为非法foobar回报some Equatable,他们的“反向”通用占位符Output1,并Output2可以通过不同类型的满足。


3.不透明的结果类型与通用占位符组成

与常规协议类型的值不同,不透明结果类型与常规通用占位符的组合很好,例如:

protocol P {
  var i: Int { get }
}
struct S : P {
  var i: Int
}

func makeP() -> some P { // Opaque result type inferred to be S.
  return S(i: .random(in: 0 ..< 10))
}

func bar<T : P>(_ x: T, _ y: T) -> T {
  return x.i < y.i ? x : y
}

let p1 = makeP()
let p2 = makeP()
print(bar(p1, p2)) // Legal, T is inferred to be the return type of makeP.

如果makeP刚刚返回P,则将无法正常工作,因为两个P值可能具有不同的基础具体类型,例如:

struct T : P {
  var i: Int
}

func makeP() -> P {
  if .random() { // 50:50 chance of picking each branch.
    return S(i: 0)
  } else {
    return T(i: 1)
  }
}

let p1 = makeP()
let p2 = makeP()
print(bar(p1, p2)) // Illegal.

为什么在混凝土类型上使用不透明的结果类型?

此时,您可能正在考虑自己,为什么不将代码编写为:

func makeP() -> S {
  return S(i: 0)
}

好吧,使用不透明的结果类型可以使您S通过仅公开提供的接口使类型成为实现细节P,从而使您可以灵活地在以后更改具体类型,而无需破坏任何依赖该功能的代码。

例如,您可以替换:

func makeP() -> some P {
  return S(i: 0)
}

与:

func makeP() -> some P { 
  return T(i: 1)
}

不会破坏任何调用的代码makeP()

有关此功能的更多信息,请参见语言指南的“不透明类型”部分Swift演变建议


20
无关:从Swift 5.1开始,return在单表达式函数中不需要
ielyamani

3
但是:func makeP() -> some P和之间有什么区别func makeP() -> P?我已经阅读了提案,也看不到他们的样本存在这种差异。
Artem


2
Swifts类型处理是一团糟。这种特殊性真的是在编译时无法处理的吗?有关参考,请参见C#。它通过简单的语法隐式处理所有这些情况。斯威夫特需要毫无意义的,几乎是货代主义的语法确实混淆了这种语言。您能否也请解释一下设计原理?(如果您也有指向github中提案的链接,那也很好)编辑:只是注意到它链接在顶部。
SacredGeometry

2
@Zmaster编译器会将两种不透明的返回类型视为不同,即使两种实现都返回相同的具体类型。换句话说,选择的特定具体类型对呼叫者隐藏。(我一直打算扩大我的回答的后半部分,使这样的事情更加明确,但还没有解决)。
Hamish

52

另一个答案很好地解释了新some关键字的技术方面,但是该答案将尝试轻松地解释原因


假设我有一个协议Animal,并且我想比较两个动物是否是兄弟姐妹:

protocol Animal {
    func isSibling(_ animal: Self) -> Bool
}

这样,只有在两只动物是同一种动物的情况下比较它们才有意义


现在让我创建一个动物的例子,仅供参考

class Dog: Animal {
    func isSibling(_ animal: Dog) -> Bool {
        return true // doesn't really matter implementation of this
    }
}

没有的方式 some T

现在让我们说我有一个从“家庭”返回动物的函数。

func animalFromAnimalFamily() -> Animal {
    return myDog // myDog is just some random variable of type `Dog`
}

注意:此函数实际上不会编译。这是因为如果协议使用“ Self”或泛型,则在添加“某些”功能之前,您无法返回协议类型。但是,假设您可以...假装将myDog转换为动物抽象类型,让我们看看会发生什么

现在的问题是,如果我尝试这样做:

let animal1: Animal = animalFromAnimalFamily()
let animal2: Animal = animalFromAnimalFamily()

animal1.isSibling(animal2) // error

这将引发错误

为什么?很好的原因是,当您打电话给animal1.isSibling(animal2)Swift时,他们不知道这些动物是狗,猫还是其他动物。至于斯威夫特知道,animal1而且animal2可能是不相关的动物物种。由于我们无法比较不同类型的动物(请参见上文)。这会出错

如何some T解决这个问题

让我们重写前面的函数:

func animalFromAnimalFamily() -> some Animal {
    return myDog
}
let animal1 = animalFromAnimalFamily()
let animal2 = animalFromAnimalFamily()

animal1.isSibling(animal2)

animal1animal2不是 Animal 他们是类,它实现动物

这使您现在可以执行的操作是在调用时animal1.isSibling(animal2),Swift知道了animal1并且animal2是同一类型。

所以我喜欢这样想:

some TSwift知道T正在使用什么实现,但类的用户却没有。

(自我宣传免责声明)我写了一篇博客文章,对该功能进行了更深入的介绍(与此处相同的示例)


2
因此,您的想法是,调用者可以利用以下事实:对调用函数的两次调用返回相同的类型,即使调用者不知道它是什么类型呢?
马特

1
@matt本质上是的。与字段等一起使用时的概念相同-向调用方保证返回类型将始终为同一类型,但不会确切显示该类型是什么。
Downgoat

@Downgoat非常感谢您的完美帖子和答案。据我了解some,返回类型是对函数主体的约束。因此some要求整个功能体内只返回一种具体类型。例如:如果存在,return randomDog则所有其他退货必须仅与一起使用Dog。所有好处都来自这个约束:可用性animal1.isSibling(animal2)和编译的好处func animalFromAnimalFamily() -> some Animal(因为现在Self在引擎盖下定义了)。这是正确的吗?
阿尔特姆

5
这行是我所需要的,animal1和animal2不是Animal,但是它们是实现Animal的类,现在都有意义!
aross

29

Hamish的回答非常棒,并且从技术角度回答了该问题。我想对为什么some在Apple的SwiftUI教程中的这个特定位置使用关键字以及为什么要遵循它是一个好习惯进行一些思考。

some 不是必需的!

首先,您无需body的return类型声明为不透明类型。您总是可以返回具体类型,而不是使用some View

struct ContentView: View {
    var body: Text {
        Text("Hello World")
    }
}

这也将编译。当查看View的接口时,您会看到的返回类型body是关联的类型:

public protocol View : _View {

    /// The type of view representing the body of this view.
    ///
    /// When you create a custom view, Swift infers this type from your
    /// implementation of the required `body` property.
    associatedtype Body : View

    /// Declares the content and behavior of this view.
    var body: Self.Body { get }
}

这意味着您可以通过body使用所选的特定类型注释属性来指定此类型。唯一的要求是该类型需要实现View协议本身。

可以是实现的特定类型,View例如

  • Text
  • Image
  • Circle

或实现的不透明类型View,即

  • some View

通用视图

当我们尝试使用堆栈视图作为body的返回类型时,就会出现问题,例如VStackHStack

struct ContentView: View {
    var body: VStack {
        VStack {
            Text("Hello World")
            Image(systemName: "video.fill")
        }
    }
}

这将无法编译,您将得到错误:

对通用类型'VStack'的引用需要<...>中的参数

这是因为SwiftUI中的堆栈视图是通用类型!💡(列表和其他容器视图类型也是如此。)

这很有意义,因为您可以插入任何数量的任何类型的视图(只要符合View协议)。VStack上面正文中的具体类型实际上是

VStack<TupleView<(Text, Image)>>

当我们以后决定将视图添加到堆栈时,其具体类型会更改。如果我们在第一个文本之后添加第二个文本,我们得到

VStack<TupleView<(Text, Text, Image)>>    

即使我们做了微小的更改,就像在文本和图像之间添加一个间隔一样细微,堆栈的类型也会改变:

VStack<TupleView<(Text, _ModifiedContent<Spacer, _FrameLayout>, Image)>>

据我所知,就是Apple在其教程中建议始终使用some View,即所有视图都满足的最通用的不透明类型作为body返回类型的原因。您可以更改自定义视图的实现/布局,而无需每次都手动更改返回类型。


补充:

如果您想更直观地了解不透明的结果类型,我最近发表了一篇文章,可能值得阅读:

Swift SwiftUI中的“一些”是什么?


2
这个。谢谢!Hamish的答案很完整,但是您的答案告诉我了为什么在这些示例中使用了它。
克里斯·马歇尔

我喜欢“一些”的想法。知道是否使用“ some”会完全影响编译时间吗?
豆腐战士

@Mischa那么如何制作泛型视图?使用包含视图和其他行为的协议?
theMouk

27

我认为到目前为止缺少的所有答案some主要是在诸如DSL(特定于域的语言)之类的东西(如SwiftUI或库/框架)中有用,这会使用户(其他程序员)与您自己有所不同。

您可能永远不会some在常规应用程序代码中使用,除非它可以包装通用协议,以便可以将其用作类型(而不只是用作类型约束)。什么some做的是让编译器保持特定类型的东西是什么知识,而把一个超门面在它的前面。

因此,在SwiftUI中(您是用户),您只需要知道a是some View,而在幕后,各种麻烦的事情就可以继续进行下去,从而使您与世隔绝。实际上,该对象是一种非常特定的类型,但是您永远不需要了解它的含义。但是,与协议不同的是,它是完整类型,因为无论出现在哪里,它都只是某些特定完整类型的基础。

在SwiftUI的未来版本中,您可能期望some View,开发人员可以更改该特定对象的基础类型。但这不会破坏您的代码,因为您的代码最初从未提到过底层类型。

因此,some实际上使协议更像是超类。它几乎是一种真实的对象类型,尽管不是完全一样(例如,协议的方法声明不能返回some)。

因此,如果您打算使用some任何东西,则很可能是正在编写供他人使用的DSL或框架/库,并且您想掩盖基础类型的详细信息。这将使您的代码更易于他人使用,并允许您在不破坏其代码的情况下更改实现细节。

但是,您也可以在自己的代码中使用它,以保护代码的一个区域免受埋在代码另一区域的实现细节的影响。


22

someSwift 5.1(swift-evolution proposal)中的关键字与Protocol一起用作返回类型。

Xcode 11 发行说明是这样表示的:

现在,函数可以通过声明其遵循的协议来隐藏其具体的返回类型,而不用指定确切的返回类型:

func makeACollection() -> some Collection {
    return [1, 2, 3]
}

调用该函数的代码可以使用协议的接口,但无法查看底层类型。(SE- 0244,40538331)

在上面的示例中,您无需告诉您将要返回Array。这样一来,您甚至可以返回仅符合的通用类型Collection


另请注意,您可能会遇到以下可能的错误:

“某些”返回类型仅在iOS 13.0.0或更高版本中可用

这意味着您应该使用可用性来避免some在iOS 12及更高版本上使用:

@available(iOS 13.0, *)
func makeACollection() -> some Collection {
    ...
}

1
非常感谢您的重点回答以及Xcode 11 beta中的编译器问题
brainray

1
您应该使用可用性来避免some在iOS 12及更高版本上使用。只要您这样做,就应该没事。问题仅在于编译器不会警告您执行此操作。
马特

2
正如您所指出的那样,简洁的Apple描述说明了这一切:函数现在可以通过声明其遵循的协议来隐藏其具体的返回类型,而不必指定确切的返回类型。 然后,调用该函数的代码可以使用协议接口。整洁然后一些。
Fattie

无需使用关键字“ some”就可以(隐藏具体的返回类型)。它没有解释在方法签名中添加“ some”的效果。
文斯·奥沙利文

@ VinceO'Sullivan some在Swift 5.0或Swift 4.2的给定代码示例中,无法删除关键字。错误是:“ 协议‘合集’只能作为一种通用的约束,因为它具有自我或相关类型的要求
心教堂

2

“ some”表示不透明类型。在SwiftUI中,将View声明为协议

@available(iOS 13.0, OSX 10.15, tvOS 13.0, watchOS 6.0, *)
public protocol View {

    /// The type of view representing the body of this view.
    ///
    /// When you create a custom view, Swift infers this type from your
    /// implementation of the required `body` property.
    associatedtype Body : View

    /// Declares the content and behavior of this view.
    var body: Self.Body { get }
}

当您将视图创建为Struct时,您遵守View协议,并告诉var主体将返回一些内容,这将确认到View Protocol。就像通用协议抽象一样,您无需定义具体的类型。


1

我将尝试用一个非常基本的实际示例来回答这个问题(这是一个不透明的结果类型

假设您具有与关联类型相关的协议,并且有两个实现它的结构:

protocol ProtocolWithAssociatedType {
    associatedtype SomeType
}

struct First: ProtocolWithAssociatedType {
    typealias SomeType = Int
}

struct Second: ProtocolWithAssociatedType {
    typealias SomeType = String
}

在Swift 5.1之前,由于ProtocolWithAssociatedType can only be used as a generic constraint错误,以下内容是非法的:

func create() -> ProtocolWithAssociatedType {
    return First()
}

但是在Swift 5.1中很好(some添加):

func create() -> some ProtocolWithAssociatedType {
    return First()
}

以上是实际用法,广泛用于SwiftUI中some View

但是有一个重要的限制-在编译时需要知道返回类型,因此下面再次Function declares an opaque return type, but the return statements in its body do not have matching underlying types出现错误将不起作用:

func create() -> some ProtocolWithAssociatedType {
    if (1...2).randomElement() == 1 {
        return First()
    } else {
        return Second()
    }
}

0

想到的一个简单用例是为数字类型编写泛型函数。

/// Adds one to any decimal type
func addOne<Value: FloatingPoint>(_ x: Value) -> some FloatingPoint {
    x + 1
}

// Variables will be assigned 'some FloatingPoint' type
let double = addOne(Double.pi) // 4.141592653589793
let float = addOne(Float.pi) // 4.141593

// Still get all of the required attributes/functions by the FloatingPoint protocol
double.squareRoot() // 2.035090330572526
float.squareRoot() // 2.03509

// Be careful, however, not to combine 2 'some FloatingPoint' variables
double + double // OK 
//double + float // error

By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.