MarshalChen's Blog

Founder of FlagshipSoft

Introduction of UltimateAndroid

| Comments

UltimateAndroid

Version:0.7.1

UltimateAndroid is a rapid development framework for developing apps

Android快速开发框架 UltimateAndroid

Master branch:Build Status

Dev branch:Build Status

English Introduction

中文简介

English Tutorials

中文详细教程

Ui Demo scrennshot

Try Demo

Update Ui for Material Design! Support Android Studio 1.0
You can see javadoc here
There is an awesome recyclerview which contains pulling to refresh, loading more, swiping to dismiss, draging and drop, animations ,showing or hiding toolbar and floating action button when scrolling and many other features,you can try it here UltimateRecyclerView.
Welcome to fork and pull request.

If you have some good idea about the framework,you can email to us or put your idea on the issue.My Email is cymcsg # gmail.com

Introduction

UltimateAndroid is a rapid development framework for developing apps.UltimateAndroid framework contains many features like View Injection,ORM,Asynchronous Networking and Image Loader,User scenario testing,over 100 Ui effects etc.And there are also many useful features like WebViewUtils,DaoUtils,Https Utils,CryptographyUtils,FileUploadUtils etc.The framework will be added more feature in the future.
The framework is like flask(a web development framework) which contains some other opensource project like Butter Knife,Asynchronous Http Client for Android, Universal Image Loader for Android and many other which I said at the end of Readme or in the updatelog.

Up to now,I have only write the demo of most parts of UI modules and View Injection.The demo is something boring,but you can see many kinds of UI modules.The DemoOfUi’s screenshots are below,and you can download the apk directly.

Demo of Ui’s screenshot is here.

New for 0.7.0:

UltimateAndroidUi project now has four separate ui projects:widget,component,animations and lollipop. So if you want to only use part of the ui project you can simply use the separate project. However if you want to use all of them, you can also use the UltimateAndroidUi project.

Update Log

Demo Manual

Quick Setup（Basic Usage）

  1. Gradle way(Recommended):

Core framework:

1
2
3
4
5
6
7

repositories {
        jcenter()
    }
dependencies {
    ...
    compile 'com.marshalchen.ultimateandroid:ultimateandroid:0.7.1'
}

Ui framework:

1
2
3
4
5
6
7

repositories {
        jcenter()
    }
dependencies {
    ...
    compile 'com.marshalchen.ultimateandroid:ultimateandroidui:0.7.0'
}

Separate Ui framework:

1
2
3
4
5
6
7

repositories {
        jcenter()
    }
dependencies {
    ...
    compile 'com.marshalchen.ultimateandroid:ultimateandroiduiwidget:0.7.0'
}

1
2
3
4
5
6
7

repositories {
        jcenter()
    }
dependencies {
    ...
    compile 'com.marshalchen.ultimateandroid:ultimateandroiduicomponent:0.7.0'
}

1
2
3
4
5
6
7

repositories {
        jcenter()
    }
dependencies {
    ...
    compile 'com.marshalchen.ultimateandroid:ultimateandroiduianimation:0.7.0'
}

1
2
3
4
5
6
7

repositories {
        jcenter()
    }
dependencies {
    ...
    compile 'com.marshalchen.ultimateandroid:ultimateandroiduilollipop:0.7.0'
}

UltimateAndroidUi project now has four separate ui projects:widget,component,animations and lollipop. So if you want to only use part of the ui project you can simply use the separate projects. However if you want to use all of them, you can also use the UltimateAndroidUi project(you can use four separate projects together either).

Normal way:

If you want to use the framework and edit it at the same time,you can use Import Project(need Android Studio version above 1.0) and choose the UltimateAndroidGradle folder.

If you want to use UltimateAndroid without the UIModules,you can just depend on UltimateAndroid and this will make the app more flexible.If you use normal way in eclipse,you can import the UltimateAndroidNormal folder and pay attention that UltimateAndroid depends on appcompat, UltimateAndroidUi depends on UltimateAndroid,and the DemoOfUi is depends on UltimateAndroidUi(Notice that the UltimateAndroidNormal project has been deprecated).

2.As the function of View Injection which uses ButterKnife,you should config your IDE before you can compile the project.Most of IDEs require additional configuration in order to enable annotation processing for Butter Knife, or you can see IntelliJ IDEA Configuration for Butter Knife or Eclipse Configuration for butter Knife.

Notice:The latest version of the framework needs Android Sdk of Version 21. If you use gradle project, you should use android studio which version should be 1.0.0+. If you use latest Android Studio ,you do not need set annotation processing

3.View Injection:

Example:

1
2
3
4
5
6
7
8
9
10
11
12

  class ExampleActivity extends Activity {
  @InjectView(R.id.title) TextView title;
  @InjectView(R.id.subtitle) TextView subtitle;
  @InjectView(R.id.footer) TextView footer;

  @Override public void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.simple_activity);
    ButterKnife.inject(this);
    // TODO Use "injected" views...
  }
}

Another use is simplifying the view holder pattern inside of a list adapter.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

public class MyAdapter extends BaseAdapter {
@Override public View getView(int position, View view, ViewGroup parent) {
    ViewHolder holder;
    if (view != null) {
      holder = (ViewHolder) view.getTag();
    } else {
      view = inflater.inflate(R.layout.whatever, parent, false);
      holder = new ViewHolder(view);
      view.setTag(holder);
    }
    holder.name.setText("John Doe");
    // etc...
    return view;
    }
    static class ViewHolder {
    @InjectView(R.id.title) TextView name;
    @InjectView(R.id.job_title) TextView jobTitle;
    public ViewHolder(View view) {
    ButterKnife.inject(this, view);
    }
    }
}

4.Asynchronous Network: Use asynchronous utils,you do not need to use an addtional Thread to visit network.It also contains file upload etc.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

HttpUtilsAsync.get("http://www.google.com", new AsyncHttpResponseHandler() {

  @Override
  public void onStart() {
      // called before request is started
  }

  @Override
  public void onSuccess(int statusCode, Header[] headers, byte[] response) {
      // called when response HTTP status is "200 OK"
  }

  @Override
  public void onFailure(int statusCode, Header[] headers, byte[] errorResponse, Throwable e) {
      // called when response HTTP status is "4XX" (eg. 401, 403, 404)
  }

  @Override
  public void onRetry(int retryNo) {
      // called when request is retried
}
});

Post request:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

HttpUtilsAsync.post("http://www.google.com", params,new AsyncHttpResponseHandler() {

  @Override
  public void onStart() {
      // called before request is started
  }

  @Override
  public void onSuccess(int statusCode, Header[] headers, byte[] response) {
      // called when response HTTP status is "200 OK"
  }

  @Override
  public void onFailure(int statusCode, Header[] headers, byte[] errorResponse, Throwable e) {
      // called when response HTTP status is "4XX" (eg. 401, 403, 404)
  }

  @Override
  public void onRetry(int retryNo) {
      // called when request is retried
}
});

5.Display Images: If you have already use or extend CommonApplication,you can use like this: ImageLoader.getInstance().displayImage((imageUri, imageView));

Or for some advantage usage:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

imageLoader.displayImage(imageUri, imageView, displayOptions, new ImageLoadingListener()  {
    @Override
    public void onLoadingStarted(String imageUri, View view) {
        ...
    }
    @Override
    public void onLoadingFailed(String imageUri, View view, FailReason failReason) {
        ...
    }
    @Override
    public void onLoadingComplete(String imageUri, View view, Bitmap loadedImage) {
    ...
    }
    @Override
    public void onLoadingCancelled(String imageUri, View view) {
     ...
     }
}, new ImageLoadingProgressListener() {
 @Override
 public void onProgressUpdate(String imageUri, View view, int current, int total) {
 ...
 }
});

1
2
3
4
5
6
7
8

  // Load image, decode it to Bitmap and return Bitmap to callback
  ImageSize targetSize = new ImageSize(120, 80); // result Bitmap will be fit to this size
  imageLoader.loadImage(imageUri, targetSize, displayOptions, new   SimpleImageLoadingListener() {
    @Override
    public void onLoadingComplete(String imageUri, View view, Bitmap loadedImage) {
        // Do whatever you want with Bitmap
    }
  });

Acceptable URIs examples:

1
2
3
4
5

String imageUri = "http://site.com/image.png"; // from Web
String imageUri = "file:///mnt/sdcard/image.png"; // from SD card
String imageUri = "content://media/external/audio/albumart/13"; // from content provider
String imageUri = "assets://image.png"; // from assets
String imageUri = "drawable://" + R.drawable.image; // from drawables (only images,   non-9patch)

NOTE: Use drawable:// only if you really need it! Always consider the native way to load drawables - ImageView.setImageResource(…) instead of using of ImageLoader.

6.ORM:

You can read the documents of GreenDao

UI Modules

  • Support animations for Android 2.3
  • EnhanceListView for listview which can swipe to dismiss the item
  • Shimmer and Titanic to let the textview more amazing
  • SmoothProgressBar to let the progress bar like Gmail or Google +
  • Flip View for implementing flipping between views as seen in the popular Flipboard application
  • PhotoView to help produce an easily usable implementation of a zooming Android ImageView
  • PagerSlidingTabStrip and ViewPagerIndicator to help customing View Pager more easily.
  • SwipeBackLayout to help you finish a activity by swipe the screen.
  • Material Design

  • And there are more than 100 UI modules which I do not mention here.

简介

框架目前主要包含的功能有View Injection,ORM,异步网络请求和图片加载，自动化脚本测试,磁盘LRU等功能.同时提供了类似于TripleDes、Webview快速设置、Cryptography处理、String处理,Https处理，文件上传等常用工具类，还有超过100多种UI控件效果。并且这些功能正在逐步增加中。

UltimateAndroid框架是如同flask框架（python）那样包含了许多其他的开源项目的框架，比如 Butter Knife,Asynchronous Http Client for Android, Universal Image Loader for Android 还有许多我在 Readme 或者 updatelog中提到的.

欢迎各种fork与提意见。

如果大家有需要的功能，欢迎随时提意见。

0.7.0新版本：

UltimateUI 项目分拆成widget，component，animations，lollipop 4个子项目，如果你只需要部分UI效果的话，你可以只依赖这些子项目.如果你想使用多个种类的UI项目的话，也可以简单的依赖UltimateAndroidUi项目(当然，你也可以依赖4个子项目)。

UI截图在这里

部分UI模块介绍（感谢arccode）

Welcome to fork.

QQ交流群：341970175（请注明Android开发）

Demo 使用方法

Demo依赖于appcompat 和 UltimateAndroid，你可以在IDE或者配置文件里面添加一下依赖。

快速入门（基础使用）

Gradle way(Recommend):

Main framework:

1
2
3
4
5
6
7

repositories {
        jcenter()
    }
dependencies {
    ...
    compile 'com.marshalchen.ultimateandroid:ultimateandroid:0.7.1'
}

Ui framework:

1
2
3
4
5
6
7

repositories {
        jcenter()
    }
dependencies {
    ...
    compile 'com.marshalchen.ultimateandroid:ultimateandroidui:0.7.0'
}

分离的UI项目:

1
2
3
4
5
6
7

repositories {
        jcenter()
    }
dependencies {
    ...
    compile 'com.marshalchen.ultimateandroid:ultimateandroiduiwidget:0.7.0'
}

1
2
3
4
5
6
7

repositories {
        jcenter()
    }
dependencies {
    ...
    compile 'com.marshalchen.ultimateandroid:ultimateandroiduicomponent:0.7.0'
}

1
2
3
4
5
6
7

repositories {
        jcenter()
    }
dependencies {
    ...
    compile 'com.marshalchen.ultimateandroid:ultimateandroiduilollipop:0.7.0'
}

1
2
3
4
5
6
7

repositories {
        jcenter()
    }
dependencies {
    ...
    compile 'com.marshalchen.ultimateandroid:ultimateandroiduianimation:0.7.0'
}
Normal way:

1.传统的library和gradle 的library在不同的文件夹中。如果你使用gradle方式,你可以拷贝 “ultimateandroid.aar” 到你的项目中 ，添加 compile(name:'ultimateandroid', ext:'aar')到gradle file中 .如果你使用gradle方式，并且想同时修改框架，可以用android studio的Import Studio Project(需要Android Studio1.0以上版本) 导入UltimateAndroidGradle文件夹。如果使用Eclipse的话，需要注意UltimateAndroid 依赖 appcompat.UltimateAndroidUi 依赖 UltimateAndroid.DemoOfUi 依赖 UltimateAndroidUi.如果你不需要使用UiModule的话，可以直接依赖UltimateAndroid，这样体积会更纤细。

2.Demo的Apk文件可以直接下载使用.由于框架使用了View Injection，大部分IDE需要开启annotation的编译（使用了Butter Knife），如果不清楚如何开启可以看一下IntelliJ IDEA Configuration for Butter Knife or Eclipse Configuration for butter Knife.

注意：UltimateAndroid框架需要API21版本的Android SDK来进行编译,如果使用了gradle的project，android studio的版本需要大于1.0.0如果你用的是最新版的Android Studio，你不需要显式的开启annotation processing了

3.视图注入：

Example:

1
2
3
4
5
6
7
8
9
10
11
12

class ExampleActivity extends Activity {
@InjectView(R.id.title) TextView title;
@InjectView(R.id.subtitle) TextView subtitle;
@InjectView(R.id.footer) TextView footer;

@Override public void onCreate(Bundle savedInstanceState) {
  super.onCreate(savedInstanceState);
  setContentView(R.layout.simple_activity);
  ButterKnife.inject(this);
  // TODO Use "injected" views...
  }
}

Another use is simplifying the view holder pattern inside of a list adapter.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

public class MyAdapter extends BaseAdapter {
@Override public View getView(int position, View view, ViewGroup parent) {
    ViewHolder holder;
    if (view != null) {
      holder = (ViewHolder) view.getTag();
    } else {
      view = inflater.inflate(R.layout.whatever, parent, false);
      holder = new ViewHolder(view);
      view.setTag(holder);
    }
    holder.name.setText("John Doe");
    // etc...
    return view;
    }
    static class ViewHolder {
    @InjectView(R.id.title) TextView name;
    @InjectView(R.id.job_title) TextView jobTitle;
    public ViewHolder(View view) {
    ButterKnife.inject(this, view);
    }
    }
}

4.异步网络请求: 使用异步网络请求工具，你不需要在额外的声明Thread来进行网络请求。同时也包括文件上传等内容。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

HttpUtilsAsync.get("http://www.google.com", new AsyncHttpResponseHandler() {

  @Override
  public void onStart() {
      // called before request is started
  }

  @Override
  public void onSuccess(int statusCode, Header[] headers, byte[] response) {
      // called when response HTTP status is "200 OK"
  }

  @Override
  public void onFailure(int statusCode, Header[] headers, byte[] errorResponse, Throwable e) {
      // called when response HTTP status is "4XX" (eg. 401, 403, 404)
  }

  @Override
  public void onRetry(int retryNo) {
      // called when request is retried
}
});

Post request:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

HttpUtilsAsync.post("http://www.google.com", new AsyncHttpResponseHandler() {

  @Override
  public void onStart() {
      // called before request is started
  }

  @Override
  public void onSuccess(int statusCode, Header[] headers, byte[] response) {
      // called when response HTTP status is "200 OK"
  }

  @Override
  public void onFailure(int statusCode, Header[] headers, byte[] errorResponse, Throwable e) {
      // called when response HTTP status is "4XX" (eg. 401, 403, 404)
  }

  @Override
  public void onRetry(int retryNo) {
      // called when request is retried
}
});

5.显示图片: 如果你已经使用或继承了CommonApplication，你可以如下使用: ImageLoader.getInstance().displayImage((imageUri, imageView));

或者高级使用:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

imageLoader.displayImage(imageUri, imageView, displayOptions, new ImageLoadingListener()  {
    @Override
    public void onLoadingStarted(String imageUri, View view) {
        ...
    }
    @Override
    public void onLoadingFailed(String imageUri, View view, FailReason failReason) {
        ...
    }
    @Override
    public void onLoadingComplete(String imageUri, View view, Bitmap loadedImage) {
    ...
    }
    @Override
    public void onLoadingCancelled(String imageUri, View view) {
     ...
     }
}, new ImageLoadingProgressListener() {
 @Override
 public void onProgressUpdate(String imageUri, View view, int current, int total) {
 ...
 }
});

1
2
3
4
5
6
7
8

// Load image, decode it to Bitmap and return Bitmap to callback
ImageSize targetSize = new ImageSize(120, 80); // result Bitmap will be fit to this size
imageLoader.loadImage(imageUri, targetSize, displayOptions, new   SimpleImageLoadingListener() {
  @Override
  public void onLoadingComplete(String imageUri, View view, Bitmap loadedImage) {
      // Do whatever you want with Bitmap
  }
});

可以使用的URI格式:

1
2
3
4
5

String imageUri = "http://site.com/image.png"; // from Web
String imageUri = "file:///mnt/sdcard/image.png"; // from SD card
String imageUri = "content://media/external/audio/albumart/13"; // from content provider
String imageUri = "assets://image.png"; // from assets
String imageUri = "drawable://" + R.drawable.image; // from drawables (only images,   non-9patch)

NOTE: Use drawable:// only if you really need it! Always consider the native way to load drawables - ImageView.setImageResource(…) instead of using of ImageLoader.

6.ORM:

可以查看Greendao的文档 ：GreenDao

UI 模块

  • 支持Android2.3 上面的动画效果
  • Listview的滑动删除
  • 动态的textview
  • 类似Gmail和Google+的进度条
  • 类似FlipBoard的翻页效果
  • 放大缩写图片的模块
  • 影视效果的图片
  • 更方便的定制ViewPager
  • 滑动后退

  • Material Design

    还有超过100多种其他模块没有提到

Warning

Some stuff is just implemented to showcase its functionality and so they are not optimized for performance and they are not done with “best practice” in mind.

Screen Shot:

tutorials2

tutorials2

tutorials2

tutorials2

tutorials2

tutorials2

tutorials2

tutorials2

tutorials2

tutorials2

tutorials2

tutorials2

tutorials2

tutorials2


Sample

You can clone the project and compile it yourself (it includes a sample), or you can check it out already compiled at Google Play

Google Play

Download demo apk directly

Notice that it might not be the latest version

The UltimateAndroid use many opensource program and I am very grateful to the author of them. The opensource program which I use:

1.JakeWharton’s Butter Knife for View Injection.

2.loopj’s Asynchronous Http Client for Android.

3.nostra13’s Universal Image Loader for Android

4.greenrobot’s greenDAO

5.pardom’s ActiveAndroid

6.JakeWharton’s DiskLruCache

7.Issacw0ng’s SwipeBackLayout

8.google-gson

9.RobotiumTech’s robotium

10.JakeWharton’s NineOldAndroids

11.JakeWharton’s Android-ViewPagerIndicator

12.RippleEffect

13.Material Menu

14.FloatingActionButton
15.FloatingActionButtonWithListView

16.Android View Animations

17.android-common

18.ListviewAnimations

19.PagerSlidingTabStrip

20.Rebound

21.Titanic

22.FaceCrop

23.KenBurns

24.AndroidSwipeLayout

There are some other projects which I write in Update Log.

If there’s anything I forgot to mention,I would be very appreciated for helping me notice it.

License

Copyright 2014 Marshal Chen

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Comments