AndroidPageObjectTest_TimeOutManagement.java

以下代码使用ApiDemos-debug.apk进行测试

//这个脚本用于演示PageFactory的功能：设置timeout时间。

 package com.saucelabs.appium;

 import com.saucelabs.appium.page_object.PageObjectWithCustomizedTimeOuts;//一个页面类，其实例传给PageFactory的进行初始化。
 import io.appium.java_client.MobileElement;
 import io.appium.java_client.android.AndroidDriver;
 import io.appium.java_client.pagefactory.AppiumFieldDecorator;
 import io.appium.java_client.pagefactory.TimeOutDuration;
 import io.appium.java_client.remote.MobileCapabilityType;
 import org.junit.After;
 import org.junit.Before;
 import org.junit.Test;
 import org.openqa.selenium.WebDriver;
 import org.openqa.selenium.remote.DesiredCapabilities;
 import org.openqa.selenium.support.PageFactory;

 import java.io.File;
 import java.net.URL;
 import java.util.Calendar;
 import java.util.List;
 import java.util.concurrent.TimeUnit;

 import static org.junit.Assert.assertEquals;

 /**
  * This sample just demonstrates that the time out customization/changing
  * works fine
  */
 public class AndroidPageObjectTest_TimeOutManagement {

     private WebDriver driver;
     private PageObjectWithCustomizedTimeOuts pageObjectWithCustomizedTimeOuts;
     private TimeOutDuration timeOutDuration;
     private final static long ACCEPTABLE_DELTA_MILLS = 1500; //Android UIAutomator sometimes
     //is very slow

     @Before
     public void setUp() throws Exception {
         //File classpathRoot = new File(System.getProperty("user.dir"));
         File appDir = new File("E:/package");
         File app = new File(appDir, "ApiDemos-debug.apk");
         DesiredCapabilities capabilities = new DesiredCapabilities();
         capabilities.setCapability(MobileCapabilityType.DEVICE_NAME, "Android Emulator");
         capabilities.setCapability(MobileCapabilityType.APP, app.getAbsolutePath());
         driver = new AndroidDriver<MobileElement>(new URL("http://127.0.0.1:4723/wd/hub"), capabilities);
         timeOutDuration = new TimeOutDuration(1, TimeUnit.SECONDS); /* This object can be passed through
         the constructor of AppiumFieldDecorator. It allows users to set general timeout
         of the waiting for elements conveniently and change it when it is needed.
         */

         pageObjectWithCustomizedTimeOuts = new PageObjectWithCustomizedTimeOuts();//一个页面类的实例。
         //This time out is set because test can be run on slow Android SDK emulator
         PageFactory.initElements(new AppiumFieldDecorator(driver, timeOutDuration),
                 pageObjectWithCustomizedTimeOuts);
     }

     @After
     public void tearDown() throws Exception {
         driver.quit();
     }

     private static void checkTimeDifference(long expectedTime,//定位元素时的期待延迟时间，也就是timeout设定的时间。
                                             TimeUnit timeUnit, long currentMillis) {//定位元素的实际所用时间
         System.out.println("expectedTime: "+expectedTime);
         System.out.println("timeUnit: "+timeUnit);
         System.out.println("currentMills: "+currentMillis);
         long expectedMillis = TimeUnit.MILLISECONDS.convert(expectedTime,
                 timeUnit);
         try {
             assertEquals(true,
                     ((currentMillis - expectedMillis) < ACCEPTABLE_DELTA_MILLS)//ACCEPTABLE_DELTA_MILLS是不加任何额外延迟的超时时间？
                             && ((currentMillis - expectedMillis) >= 0));//若这个断言成立，则说明：使用timeOutDuration设置的额外延迟生效了，且定位元素所用时间与额外延迟时间的差值小于默认的超时时间。
         }
         catch (Error e){
             String message = String.valueOf(expectedTime) + " "  + timeUnit.toString() + " current duration in millis " +
                     String.valueOf(currentMillis) + " Failed";
             throw new RuntimeException(message, e);
         }
     }

     private long getBenchMark(List<MobileElement> stubElements) {
         long startMark = Calendar.getInstance().getTimeInMillis();
         stubElements.size();//在PageFactory模式下，使用页面类中的元素，会触发查找元素。所以getBenchMark函数的作用是，测量定位元素的所用时间。
         long endMark = Calendar.getInstance().getTimeInMillis();
         return endMark - startMark;
     }

     /**
      * Please read about Page Object design pattern here:
      *  https://code.google.com/p/selenium/wiki/PageObjects
      */
      /**
      * Page Object best practice is to describe interactions with target
      * elements by methods. These methods describe business logic of the page/screen.
      * Here test interacts with lazy instantiated elements directly.
      * It was done so just for obviousness
      */

     @Test
     public void test() {
         checkTimeDifference(AppiumFieldDecorator.DEFAULT_IMPLICITLY_WAIT_TIMEOUT, AppiumFieldDecorator.DEFAULT_TIMEUNIT,
                 getBenchMark(pageObjectWithCustomizedTimeOuts.stubElements));
         System.out.println(String.valueOf(AppiumFieldDecorator.DEFAULT_IMPLICITLY_WAIT_TIMEOUT)
                 + " " + AppiumFieldDecorator.DEFAULT_TIMEUNIT.toString() + ": Fine");

         timeOutDuration.setTime(15500000, TimeUnit.MICROSECONDS);//更改定位元素的超时时间。
         checkTimeDifference(15500000, TimeUnit.MICROSECONDS, getBenchMark(pageObjectWithCustomizedTimeOuts.stubElements));
         System.out.println("Change time: " + String.valueOf(15500000) + " "
                 + TimeUnit.MICROSECONDS.toString() + ": Fine");

         timeOutDuration.setTime(3, TimeUnit.SECONDS);
         checkTimeDifference(3, TimeUnit.SECONDS, getBenchMark(pageObjectWithCustomizedTimeOuts.stubElements));
         System.out.println("Change time: " + String.valueOf(3) + " "
                 + TimeUnit.SECONDS.toString() + ": Fine");
     }

     @Test
     public void test2() {
         checkTimeDifference(AppiumFieldDecorator.DEFAULT_IMPLICITLY_WAIT_TIMEOUT, AppiumFieldDecorator.DEFAULT_TIMEUNIT,
                 getBenchMark(pageObjectWithCustomizedTimeOuts.stubElements));//查找stubElements。
         System.out.println(String.valueOf(AppiumFieldDecorator.DEFAULT_IMPLICITLY_WAIT_TIMEOUT)
                 + " " + AppiumFieldDecorator.DEFAULT_TIMEUNIT.toString() + ": Fine");

         checkTimeDifference(5, TimeUnit.SECONDS,
                 getBenchMark(pageObjectWithCustomizedTimeOuts.stubElements2));
         System.out.println(String.valueOf(5)
                 + " " + TimeUnit.SECONDS.toString() + ": Fine");

         timeOutDuration.setTime(15500000, TimeUnit.MICROSECONDS);
         checkTimeDifference(15500000, TimeUnit.MICROSECONDS, getBenchMark(pageObjectWithCustomizedTimeOuts.stubElements));
         System.out.println("Change time: " + String.valueOf(15500000) + " "
                 + TimeUnit.MICROSECONDS.toString() + ": Fine");

         checkTimeDifference(5, TimeUnit.SECONDS,
                 getBenchMark(pageObjectWithCustomizedTimeOuts.stubElements2));
         System.out.println(String.valueOf(5)
                 + " " + TimeUnit.SECONDS.toString() + ": Fine");

     }
 }

输出结果为

//下面是test的结果
expectedTime: 1
timeUnit: SECONDS
currentMills: 1343//查找 stubElements 的所用时间，说明在setup中设置的timeOutDuration生效了。
1 SECONDS: Fine
expectedTime: 15500000
timeUnit: MICROSECONDS
currentMills: 15559//查找 stubElements 的所用时间，说明在test中设置的timeOutDuration生效了。
Change time: 15500000 MICROSECONDS: Fine
expectedTime: 3
timeUnit: SECONDS
currentMills: 3602//查找 stubElements 的所用时间，说明在test中设置的timeOutDuration生效了。
Change time: 3 SECONDS: Fine
//下面是test2的结果
expectedTime: 1
timeUnit: SECONDS
currentMills: 1721//查找 stubElements 的所用时间，说明在setup中的设置生效了，其它test中的设置不影响test2。
1 SECONDS: Fine
expectedTime: 5 //查找 stubElements2 的所用时间，说明页面类中的WithTimeout注解生效了，优先级高于setup中的设置。
timeUnit: SECONDS
currentMills: 5482
5 SECONDS: Fine
expectedTime: 15500000
timeUnit: MICROSECONDS
currentMills: 15543//查找 stubElements 的所用时间，说明在test2中设置的timeOutDuration生效了。
Change time: 15500000 MICROSECONDS: Fine
expectedTime: 5
timeUnit: SECONDS
currentMills: 6269//查找 stubElements2 的所用时间，说明页面类中的WithTimeout注解生效了，优先级高于test2的timeOutDuration设置。
5 SECONDS: Fine

Process finished with exit code 0

下面为页面类的代码

 package com.saucelabs.appium.page_object;

 import io.appium.java_client.MobileElement;
 import io.appium.java_client.pagefactory.WithTimeout;
 import org.openqa.selenium.support.FindBy;

 import java.util.List;
 import java.util.concurrent.TimeUnit;

 public class PageObjectWithCustomizedTimeOuts {

     /**
      * Page Object best practice is to describe interactions with target
      * elements by methods. This methods describe business logic of the page/screen.
      * Here lazy instantiated elements are public.
      * It was done so just for obviousness
      */

     @FindBy(className = "OneClassWhichDoesNotExist")
     public List<MobileElement> stubElements;

     /*Any timeout of the waiting for element/list of elements
       can be customized if the general time duration is
       not suitable. E.g. the element is rendered for a long time
       or the element is used just for instant checkings/assertions
      */
     @WithTimeout(time = 5, unit = TimeUnit.SECONDS)
     @FindBy(className = "OneAnotherClassWhichDoesNotExist")
     public List<MobileElement> stubElements2;
 }

关于timeOutDuration和timeout注解的总结如下：

• timeOutDuration的设置对元素生效；
• 不同test中的timeOutDuration设置互不干扰；
• 若页面类中的元素有WithTimeout注解，则注解优先级高于test中的timeOutDuration设置。