【翻译】当我开始Android开发时,希望能早点认识的一些开源库

Table of Contents

原文地址 https://speakerdeck.com/chrisguzman/android-libraries-i-wish-i-knew-when-i-started

介绍:当从事App开发时,有时候没必要重复造轮子,尤其是对新手而言。 这个演讲涵盖了一些可以在App开发时使用的库,这些库可以解决你正在遇到的问题。 无论是要从Web接口获取数据, 或者显示、缓存图片, 或者存储、同步数据, 这些库都可以帮助你。

本文是翻译的Groupon工程师Chris Guzman的一个演讲PPT。作者以一个45分钟“hackathon”的方式, 从零开始构造一个App "TAaSKY", 这个App用于展示做"土豆"的食谱. 作者逐步介绍在开发这个app过程中使用到的开源库。

第一步:构造、使用view - Butter Knife

这一步是用来构造TAaSKY应用的UI界面.

基本使用

下面的内容是activity的一个简略的layout文件,这是开发App过程中 必不可少的东西,当写完layout之后,大部分情况下都需要在代码中 引用相关的组件。这里就可以使用在Android领域举世闻名的开源库: Butter Knife。

<LinearLayout ... android:orientation="vertical">
<ImageView android:id="@+id/taco_img" .../>
<TextView android:id="@+id/description" .../>
<LinearLayout android:orientation="horizontal" .../>
<Button android:id="@+id/reject" .../>
<Button android:id="@+id/info" .../>
<Button android:id="@+id/save" .../>
</LinearLayout>
<EditText android:id="@+id/tag" .../>
</LinearLayout>

Butter Knife通过注解的方式将代码和xml文件绑定到一起,无需在 重复写大量的 findViewById() 这种代码。该库有以下几个优势:

  1. 没有拖慢程序速度。
  2. 改善view查找。
  3. 改善监听函数注册。
  4. 改善资源查找。
<TextView android:id="@+id/description"
 ...
 />
public class MainActivity extends Activity {
   @BindView(R.id.description) TextView description;

   @Override
   protected void onCreate(Bundle bundle) {
      ...
      ButterKnife.bind(this);
      description.setText("Tofu with Cheese on a tortilla");
   }
}

下面是一个通常的Butter Knife用法, ButterKnife.bind(this) 函数 会自动生成代码寻找相关的view、资源并把它们保存到activity代码中。 类似这样:

public void bind(MainActivity activity) {
   activity.description = (android.widget.TextView) activity.findViewById(2130968577);
}

下面是一些更高级的用法:

绑定、解绑fragment中的view

public class TacoFragment extends Fragment {
 @BindView(R.id.tag) EditText tag;
 private Unbinder unbinder;

 @Override
 public View onCreateView(LayoutInflater inflater, ViewGroup group, Bundle bundle) {
      ...
      //Important!
      unbinder = ButterKnife.bind(this, parentView);
      tag.setHint("Add tag. Eg: Tasty!, Want to try")
      return view;
 }

 @Override
 public void onDestroyView() {
      super.onDestroyView();
      //sets the views to null
      unbinder.unbind();
 }
}

注册监听函数

ButterKnife支持大部分常用的监听函数。

@OnClick(R.id.save)
public void saveTaco(Button button) {
 button.setText("Saved!");
}

绑定资源

class MainActivity extends Activity {
 @BindString(R.string.title) String title;
 @BindDrawable(R.drawable.star) Drawable star;
 // int or ColorStateList
 @BindColor(R.color.guac_green) int guacGreen;
 // int (in pixels) or float (for exact value)
 @BindDimen(R.dimen.spacer) Float spacer;
}

给多个组件设置同一个监听函数

@OnClick({ R.id.save, R.id.reject})
public void actOnTaco(View view) {
 if (view.getId() == R.reject) {
    Toast.makeText(this, "Ew Gross!", LENGTH_SHORT).show();
 }
 else {
    Toast.makeText(this, "Yummy :)", LENGTH_SHORT).show();
 }
 //TODO: implement
 getNextTaco();
}

操作view的属性

//下面的代码将两个button绑定到一个list中, 并通过操作这个list来
//操作这些按钮的属性。
@BindViews({R.id.save, R.id.reject})
List<Button> actionButtons;
ButterKnife.apply(actionButtons, View.ALPHA, 0.0f);

ButterKnife.apply(actionButtons, DISABLE);
ButterKnife.apply(actionButtons, ENABLED, false);
static final ButterKnife.Action<View> DISABLE = new ButterKnife.Action<View>() {
 @Override public void apply(View view, int index) {
    view.setEnabled(false);
 }
};
static final ButterKnife.Setter<View, Boolean> ENABLED = new ButterKnife.Setter<View, Boolean>() {
 @Override public void set(View view, Boolean value, int index) {
    view.setEnabled(value);
 }
};

第二步:加载网络图片 - Picasso

这一步用于在应用显示土豆的照片, 照片可能是网络或本地图片.

通过第一步的代码,UI部分基本已经写完了。然后接下来要实现APP的一个功能, 从网络下载图片并显示. 这里用到了一个同样有名的开源库: Picasso.

基本介绍

该库的一些特点包括:

  1. 进行HTTP请求.
  2. 缓存图片.
  3. 简单的"resize/裁剪/居中/放大"操作.
  4. 负责在主线程之外进行http请求.
  5. 对RecyclerView的view进行合理回收.

在介绍Picasso之前, 先看一下比较通用的"自己写"的下载图片代码:
这段代码通过http请求获取图片的stream, 然后再调用Android的BitmapFactory 类来将stream转化成bitmap. 其中 OpenHttpGETConnection()函数还要考虑在 子线程中进行http请求操作.

private Bitmap DownloadImage(String url)
{
 Bitmap bitmap = null;
 InputStream in = null;
 try {
    in = OpenHttpGETConnection(url);
    bitmap = BitmapFactory.decodeStream(in); in.close();
 } catch (Exception e) {
    Log.d("DownloadImage", e.getLocalizedMessage());
 }
 return bitmap;
}

如果使用Picasso,则上面的代码就变为:

Picasso.with(context)
 .load("http://placekitten.com/200/300")
 .into(imageView);

更多特性

上面展示了Picasso的一个典型使用方式, 该库还包含其他的对图片的操作, 例如:

  1. placeholder(R.mipmap.loading) 占位图片, 可以是一个资源或者drawable
  2. error(R.drawable.sad_taco) 如果加载失败显示的图片
  3. fit() //reduce the image size to the dimensions of imageView 将图片大小缩减到imageView的大小.
  4. resize(imgWidth, imgHeight) //resizes the image in pixels 缩减到指定图片大小. 单位是px
  5. centerCrop() //or .centerInside() 居中裁剪.
  6. rotate(90f) 旋转图片. 或者也可以使用函数 rotate(degrees, pivotX, pivotY)

除了网络下载图片, Picasso也支持加载本地图片. 例如下面的代码:

Picasso.with(context).load(R.drawable.salsa).into(imageView1);
Picasso.with(context).load("file:///asset/salsa.png").into(imageView2);
Picasso.with(context).load(new File(...)).into(imageView3);

一个完整的代码片段

下面是Picasso和ButterKnife一起用的场景, 在通过Picasso下载图片时, 使用 ButterKnife的apply函数来使按钮不可用.

//Butter Knife!
@BindView(R.id.taco_img) ImageView tacoImg;
private void setTacoImage() {
 Picasso.with(context)
 .load("http://tacoimages.com/random.jpg")
 .into(tacoImg);
}
private void getNextTaco() {
 ButterKnife.apply(actionButtons, DISABLE);
 setTacoImage();
 //TODO: implement
 loadTacoDescription();
}

第三步: json转换 - Gson

这一步用于对服务器返回的json格式数据转化成类对象, 或者反过来.

基本介绍

Gson的一些特点:

  1. (可以)不需要在类中使用注解.
  2. 性能好.
  3. 使用广泛.
  4. 默认包含类(包括父类)的所有域.
  5. 支持多维数组.
  6. 当序列化时, 类的值为null的变量会被跳过.
  7. 反序列化时, json中没有的域会在对象中生成一个null值.

例如下面的例子对类Taco使用Gson进行Json的序列化和反序列化.

class Taco {
 private String description;
 private String imageUrl;
 private String tag;
 //not included in JSON serialization or deserialization
 private transient boolean favorite;
 Taco(String description, String imageUrl, String tag, boolean favorite) {
 ....
 }
}

// Serialize to JSON
Taco breakfastTaco = new Taco("Eggs with syrup on pancake", "imgur.com/123", "breakfast", true);
Gson gson = new Gson();
String json = gson.toJson(breakfastTaco);
// ==> json is {description:"Eggs with syrup on pancake", imageUrl:"imgur.com/123", tag:"breakfast"}
// Deserialize to POJO
Taco yummyTaco = gson.fromJson(json, Taco.class);
// ==> yummyTaco is just like breakfastTaco except for the favorite boolean

高级用法

  1. 如果变量名和json的域名不同, 可以使用 @SerializeName() 注解修饰.

    public class Taco {
        @SerializedName("serialized_labels")
        private String tag;
    }
    
  2. 通过Gson的API客制化输出.

       //如果变量值为null,则输出中也输出null,而不是忽略.
    Gson gson = new GsonBuilder().serializeNulls().create();
    //保留空格
    Gson gson = new GsonBuilder().setPrettyPrinting().create();
    
  3. 设置日期格式

    public String DATE_FORMAT = "yyyy-MM-dd";
    GsonBuilder gsonBuilder = new GsonBuilder();
    gsonBuilder.setDateFormat(DATE_FORMAT);
    Gson gson = gsonBuilder.create();
    

第四步: 请求网络数据 - Retrofit (请不要再使用AsyncTask了, 真的, 停下来吧)

这一步用于从服务器上获取数据.

基本介绍

Retrofit的一些特点:

  1. 类型安全.
  2. 支持认证.
  3. 支持json的序列化和反序列化.
  4. 支持RxJava
  5. 支持同步和异步请求.

典型使用

下面是Retrofit的一个典型应用, (更多介绍可以看这里):

  1. 定义API
public interface TacoApi {
 // Request method and URL specified in the annotation
 // Callback for the parsed response is the last parameter
 @GET("random/")
 Call<Taco> randomTaco(@Query("full-taco") boolean full);
 @GET("contributions/")
 Call<List<Contributor>> getContributors();
 @GET("contributions/{name}")
 Call<Contributor> getContributors(@Path("name") String username));
 @POST("recipe/new")
 Call<Recipe> createRecipe(@Body Recipe recipe);
}
  1. 使用api进行请求
    1. 同步请求:

      Retrofit retrofit = new Retrofit.Builder()
          .baseUrl("http://taco-randomizer.herokuapp.com/")
          .addConverterFactory(GsonConverterFactory.create())
          .build();
      
          // 创建api实例
          TacoApi tacoApi = retrofit.create(TacoApi.class);
          // 创建请求
          Call<Taco> call = tacoApi.randomTaco(true);
          // 执行请求
          Taco taco = call.execute().body();
      
    2. 异步请求

      Recipe recipe = new Recipe();
      Call<Recipe> call = tacoApi.createRecipe(recipe);
      call.enqueue(new Callback<Recipe>() {
          @Override
          public void onResponse(Call<Recipe> call, Response<Recipe> response) {}
          @Override
          public void onFailure(Call<Recipe> call, Throwable t) {}
      

小技巧

  1. 通过注解修改请求的url

    @POST("http://taco-randomizer.herokuapp.com/v2/taco")
    private Call<Taco> getFromNewAPI();
    
  2. 添加请求头部

    @Headers({"User-Agent: tacobot"})
    @GET("contributions/")
    private Call<List<Contributor>> getContributors();
    

第五步: 存储数据 - Realm (sqlite的替代品)

这一步用于将服务器返回的数据(如食谱)存储起来.

基本介绍

Realm的一些特点:

  1. 为手机而生.
  2. 可以快到使用同步.
  3. 支持一个应用包含多个Realm数据库.(Sqlite只有一个).

下面是Realm在App中的应用实例:

  1. 需要持久化的类需要继承RealmObject:

    public class Taco extends RealmObject {
     private String description;
     private String tag;
     private String imageUrl;
     private boolean favorite;
     //getters and setters
    }
    
  2. 配置Realm, 一般是创建一个RealmConfiguration对象, 将Realm文件存储到 App的"file"目录下.

    RealmConfiguration realmConfig =
     new RealmConfiguration.Builder(context).build();
    Realm.setDefaultConfiguration(realmConfig);
    // Get a Realm instance for this thread
    Realm realm = Realm.getDefaultInstance();
    
  3. 持久化. Realm支持存储一个已存在的类实例, 或者通过传入class文件直接存储一个 新的类实例.

    realm.beginTransaction(); // Persist your data in a transaction
    final Taco managedTaco = realm.copyToRealm(unmanagedTaco); // Persist unmanaged objects
    Taco taco = realm.createObject(Taco.class); // Create managed objects directly
    realm.commitTransaction();
    
  4. 获取数据.

    Realm realm = Realm.getDefaultInstance(); // Get a Realm instance for this thread
    final RealmResults<Taco> likedTacos =
    realm.where(Taco.class).equalTo("favorite", true).findAll(); //find all favorite tacos
    
  5. 删除操作:

    // All changes to data must happen in a transaction
    realm.executeTransaction(new Realm.Transaction() {
     @Override
     public void execute(Realm realm) {
     // remove single match
     limeTacos.deleteFirstFromRealm();
     //or limeTacos.deleteLastFromRealm();
     // remove a single object
     Taco fishTaco = limeTacos.get(1);
     fishTaco.deleteFromRealm();
     // Delete all matches
     limeTacos.deleteAllFromRealm();
     }
    });
    

一些特性

  1. Realm同样支持同步和异步的"写数据"操作, 通过调用不同的Api实现, 如下代码:
    1. 同步写:

      //Transaction block
      realm.executeTransaction(new Realm.Transaction() {
       @Override
       public void execute(Realm realm) {
          Taco taco = realm.createObject(Taco.class);
          taco.setDescription("Spaghetti Squash on Fresh Corn Tortillas");
          user.setImageUrl("http://tacoimages.com/1.jpg");
       }
      });
      
    2. 异步写, 需要传入两个个回调类对象参数, 分别是成功和失败的回调.

      realm.executeTransactionAsync(new Realm.Transaction() {
        @Override
        public void execute(Realm bgRealm) {
           Taco taco = bgRealm.createObject(Taco.class);
           taco.setDescription("Spaghetti Squash on Fresh Corn Tortillas");
           user.setImageUrl("http://tacoimages.com/1.jpg");
        }}, new Realm.Transaction.OnSuccess() {
               @Override
               public void onSuccess() {}}, 
            new Realm.Transaction.OnError() {
               @Override
               public void onError(Throwable error) {}
       });
      
  2. 跟Gson一样, Realm也支持类成员变量的解析. 例如:

    public class Taco extends RealmObject {
     ...
     private List<Ingredient>
     ...
    }
    public class Ingredient extends RealmObject {
     private String name;
     private URL url;
    }
    
    RealmResults<Taco> limeTacos = realm.where(Taco.class)
     .equalTo("ingredients.name", "Lime")
     .findAll();
    
  3. 为RealmObject和RealmResults增加数据变化的listener.

    limeTacos.addChangeListener(
     new RealmChangeListener<RealmResults<Taco>>() {
     @Override
     public void onChange(RealmResults<Taco> tacosConLimon) {
     //tacosConLimon.size() == limeTacos.size()
     // Query results are updated in real time
         Log.d("LimeTacos", "Now we have" + limeTacos.size() + " tacos");
     }
    });
    
  4. 为防止内存泄漏, 需要在onDestroy中关闭Realm.

    @Override
    protected void onDestroy() {
     realm.removeChangeListener(realmListener); // Remove the listener.
     realm.close(); //or realm.removeAllChangeListeners(); Close the Realm instance.
    }
    

番外篇: 简便启动activity - Dart + Henson

这两个类是受到ButterKnife启发实现的, 提供了一个更简便的启动Activity的方法, 作者说, 不要再浪费时间写这样的代码啦.

intent.putExtra(EXTRA_TACO_DESCRIPTION, "Seasoned Lentils with Green Chile on Naan");
tacoDescription = getIntent().getExtras().getString(EXTRA_TACO_DESCRIPTION);

基本用法

  1. Dart定义intent使用到的参数.

    public class TacoDetailActivity extends Activity {
     //Required. Exception thrown if missing
     @InjectExtra boolean favorite;
     @InjectExtra String description
     //default value if left null
     @Nullable @InjectExtra String tag = "taco";
     //Ingredient implements Parcelable
     @Nullable @InjectExtra Ingredient withIngredient;
     @Override
     public void onCreate(Bundle bundle) {
     super.onCreate(bundle);
     Dart.inject(this);
     //TODO use member variables
     ...
     }
    }
    
  2. 使用Henson生成intent.

    //Start intent for TacoDetailActivity
    Intent intent = Henson.with(context)
     .gotoTacoDetailActivity()
     .favorite(true)
     .description("Seasoned Lentils with Green Chile on Naan")
     .ingredient(new Ingredient())
     .build();
    // tag is null or defaults to "taco"
    startActivity(intent);
    

Created At <2016-08-14 Sun 23:25> by Luis Xu. Email: xuzhengchaojob@gmail.com