Robolectric——Shadows 官网翻译

Posted 2022-10-17 我爱烤冷面

Robolectric 通过创建一个包含真实android 框架代码的运行时环境来进行工作。 这意味着，当你的测试或被测试代码调用到Android框架时，你会获得更真实的体验，因为这跟在实际设备上执行的大部分代码都是相同的。然而还是有一些限制：

1. Native code（源代码） - Android源代码不能在你的开发机器上执行。
   2.Out of process calls（进程外调用） - 你的开发机器上没有运行Android系统服务。
   3.不足的测试Api - Android几乎没有适合测试的api。

Robolectric通过一组名字叫做Shadows的类来解决这些问题。每一个shadow 能拓展或继承Android系统中对应类的行为。当一个Android类被实例化，Robolectric会去查找一个对应的shadow类，如果找到了，就会去创建一个与之关联的shadow对象。

通过使用字节码工具，Robolectric能够编写出跨平台伪实现来替代原生代码，并添加额外的api来实现测试。

名字是什么意思？
为什么叫“Shadow”？Shadow 对象们不是完全的Proxies, 不是完全的Fakes，不是完全的Mocks或Stubs。Shadows 有时是隐藏的，有时是可见的，并且可以引导你找到真正的对象。至少我们没有叫它们“sheep”，这是我们正在考虑的。

Shadow Classes
Shadow Classes 总是需要一个 public 类型的无参构造函数以便Robolectric框架可以实例化他们。它们通过类声明上的@Implements注释与它们所映射的类相关联。
Shadow 类应该模仿映射类的继承层次关系。例如，如果你实现一个ViewGroup的Shadow，ShadowViewGroup,然后你的Shadow类需要继承于ViewGroup的父类Shadow,ShadowView。例如：

@Implements(ViewGroup.class)
public class ShadowViewGroup extends ShadowView

Methods
Shadow 对象们实现了与Android类中具有相同特征的方法。Robolectric将在调用Android对象上具有相同特征的方法时调用Shadow对象上的方法。

假设一个应用程序定义了以下一行代码:

this.imageView.setImageResource(R.drawable.pivotallabs_logo);

在测试中，Shadow实例上的shadowimageview# setImageResource(int resId)方法将被调用。
Shadow方法必须用@Implementation注释标记。Robolectric包括一个校验测试，以确保测试正确进行。

@Implements(ImageView.class)
public class ShadowImageView extends ShadowView...
@Implementation
protected void setImageResource(intresId)// implementation here.

Robolectric支持在原始类上shadowing所有方法，包括private、static、final或native。

通常@Implementation方法也应该有protected修饰符。 这样做的目的是减少shadows的API表面范围;测试者应该总是直接在Android框架类上调用这些方法。

重要的是，shadow方法是在最初定义它们的类的相应shadow上实现的。 否则，Robolectric的查找机制将找不到它们(即使它们是在shadow子类中声明的)。举个例子，setEnabled()方法定义在View里面。如果setEnabled()方法被定义在ShadowViewGroup而不是ShadowView，那么即使在一个实例化的ViewGroup上调用setEnabled()，它也不会在运行时被找到。

Shadowing Constructors

一旦一个Shadow对象被实例化，Robolectric将寻找一个名为__constructor__并带有@Implementation注解的构造方法，该方法与在真实对象上调用的构造函数具有相同的参数。

例如，如果应用程序代码调用TextView构数，它接收一个Context:

new TextView(context);

Robolectric 将会调用如下__constructor__接收一个Context的方法：

@Implements(TextView.class)
public class ShadowTextView
@Implementation
protected void __constructor__(Context context)
	this.context=context;

Getting access to the real instance(- 访问真实的实例)

有时，Shadow类可能想要引用它们对应类的对象，例如，操作字段。Shadow类可以通过声明一个带注释的@RealObject字段来实现这一点:

@Implements(Point.class)
publicclassShadowPoint
@RealObject
private Point realPoint;
public void __constructor__(intx,inty)
	realPoint.x=x;
	realPoint.y=y;
	

在调用任何其他方法之前，Robolectric会将realPoint设置为Point的实际实例。

Custom Shadows（自定义）
Robolectric还在改进中，我们依赖、欢迎并强烈鼓励社区对bug修复和功能缺陷的贡献。然而，如果你想以一种不适合共享的方式修改阴影行为，或者你不能等待一个新版本包含一个关键的修复，我们支持自定义阴影。

Writing a Custom Shadow（书写一个自定义的Shadows）
自定义的shadow结构与普通的shadow类非常相似。他们必须在类的定义上包含@Implements(AndroidClassName.class)注解。你可以使用普通shadow的实现方式，例如通过@Implementation标记实现方法或者使用public void constructor(…)标记构造方法。如果你喜欢，你可以让你的shadow类继承于普通的 Robolectric shadows。

@Implements(Bitmap.class)
public class MyShadowBitmap 
	@RealObject
	private Bitmap realBitmap;
	private int bitmapQuality = -1;
	@Implementation
	public boolean compress(Bitmap.CompressFormat format, int quality, OutputStream stream) 
	bitmapQuality = quality;
	return realBitmap.compress(format, quality, stream);
	
	public int getQuality() 
	return bitmapQuality; 
	

Using a Custom Shadows
使用Shadows数组属性，在测试类或测试方法上使用@Config注释将自定义shadow连接到Robolectric。要使用上一节中提到的MyShadowBitmap类，您需要用@Config(shadows=MyShadowBitmap.class)注释有问题的测试，如果包含多个自定义shadow:@Config(shadows=MyShadowBitmap.class, MyOtherCustomShadow.class)。这使得Robolectric在对被隐藏的类执行代码时能够识别并使用自定义的阴影。

如果您希望将自定义shadow应用于套件或某个包中的所有测试，则可以通过robolectric配置shadow robolectric.properties文件。注意，默认情况下shadows. shadowof()方法不适用于自定义阴影。相反，您可以使用Shadow.extract()并将返回值转换为您实现的自定义Shadow类。

Building a library of Custom Shadows.

如果您发现自己正在构建一个自定义shadow库，那么您应该考虑在您的shadow库上运行Robolectric的shadow注释处理器。这提供了许多好处，例如

1. 为你的每一个shadow生成shadowOf方法
2. 生成一个ServiceLoader，这样如果在类路径中找到自定义shadow，就会自动应用它
3. 在teardown时调用任何static @Resetter方法，使您能够重置静态状态。
4. 对shadow执行额外的验证和检查。

android 
	defaultConfig 
		javaCompileOptions 
			annotationProcessorOptions 
				className 'org.robolectric.annotation.processing.RobolectricProcessor' arguments = [ 'org.robolectric.annotation.processing.shadowPackage' : 'com.example.myshadowpackage' ]
			
		 
	 

dependencies  annotationProcessor project(":processor") 

最佳实践：
Limit API surface area of shadows.
因为Robolectric 3.7的@Implementation方法，包括__constructor__方法可以被保护。这是可取的，因为测试代码没有业务调用这些方法，通过使您的@Implementation方法受保护，你鼓励测试作者调用公共Android api代替。

Don’t use useinheritImplementationMethods
这通常是不必要的，在Robolectric 3.8中将被移除

不要在shadows中重写 eaquls, hashCode 和 toString
避免这种情况。要在测试中测试相等性以进行比较，请选择辅助程序库或断言库。更喜欢添加一个describe()方法，而不是shadowing toString()

编写高质量的shadow，以促进测试行为而不是实现。
比起使用shadow作为美化的论据，更喜欢编写一个shadow来鼓励测试行为。例如，不要添加公开已注册侦听器的方法，而要为调用这些侦听器的方法添加@Implementation。

在shadow自己的代码时要小心
Robolectric提供了大量的能力，这需要负责任的使用。Shadows是测试与Android框架交互的理想工具，因为该框架不支持依赖注入，并且可以自由使用静态代码。在为自己的代码编写自定shadow之前，请考虑是否不能更好地重构代码并使用流行的模仿库(如Mockito)。

—————————————————————————————————

个人总结：
Robolectric通过Shadow的来映射Android 中的类，这样就可以直接在单元测试中使用Android的类。当Robolectric中提供的Shadow没有你需要的类的时候，比如你的自定义View的类，在Robolectric中必然是没有的，这个时候就可以使用自定义Shadow来实现。