Android开发思考之内容检查代码优化

前言

平时我们写代码比如登录注册，在调接口之前肯定要检查手机号啊，密码啊是否规范，本文称为内容检查。大多数人可能就是用if判断一大串，我也是，但是现在很烦，很low，所以想优化一下这种代码。

mDataBing.btnRegister.setOnClickListener(v -> {

            String phoneNum = mDataBing.edtPhone.getText().toString().trim();
            String password = mDataBing.edtPassword.getText().toString().trim();

            if (TextUtils.isEmpty(phoneNum)) {
                toast("手机号不能为空");
                return;
            }

            if (RegexUtils.isMobileExact(phoneNum)) {
                toast("手机号不正确");
                return;
            }

            if (TextUtils.isEmpty(password)) {
                toast("密码不能为空");
                return;
            }

            if (password.length() < 6) {
                toast("密码不能少于6位");
                return;
            }

            //注册
            register();

        });

有的app非空可能不会检查，而是当输入内容为空时让提交按钮不可点击。也就是当所有的EditText有内容时，按钮才可点击。我也写了个工具类：

/**
 *
 * @author XuNeverMore
 * @QQ 1045530120
 * @create on 2018/2/2 0002
 * @github https://github.com/XuNeverMore
 */

public class SubmitUtil implements TextWatcher {


    private Button btnSubmit;//提交按钮
    private EditText[] editTexts;//需要填写内容的输入框


    private SubmitUtil() {

    }

    public SubmitUtil(Button btnSubmit, EditText... editTexts) {
        this.btnSubmit = btnSubmit;
        this.editTexts = editTexts;
    }


    public static SubmitUtil newInstance(){
        return new SubmitUtil();
    }

    public SubmitUtil setSubmitBtn(Button btnSubmit){
        this.btnSubmit = btnSubmit;
        return this;
    }

    public SubmitUtil setEditTexts(EditText... editTexts){
        this.editTexts = editTexts;
        return this;
    }

    /**
     * 同步操作
     */
    public SubmitUtil syncOperations(){
        for(EditText e:editTexts){
            e.addTextChangedListener(this);
        }
        checkState();
        return this;
    }



    @Override
    public void beforeTextChanged(CharSequence s, int start, int count, int after) {

    }

    @Override
    public void onTextChanged(CharSequence s, int start, int before, int count) {
        checkState();
    }

    private void checkState() {
        boolean notEmpty = isAllEditTextNotEmpty();
        btnSubmit.setEnabled(notEmpty);
    }

    /**
     * 所有EditText输入内容均非空
     * @return
     */
    private boolean isAllEditTextNotEmpty() {

        for(EditText e:editTexts){
            if(TextUtils.isEmpty(e.getText().toString().trim())){
                return false;
            }
        }

        return true;
    }

    @Override
    public void afterTextChanged(Editable s) {

    }
}

首先看下图，基本的流程。之前写博客没画过流程图，随便找了个软件画了下。流程图是不是这样画的，我不知道，意思大概就是这样：

map.png

这样思路清晰点，主要工作就是我要写一个工具类，可以检查多个条件，并且这些条件是可以配置的（比如你要辣椒不要醋，我要醋不要葱，他全都要，干扰你哈哈）。当一个条件不满足时需要进行相应的提示，并返回结果false;当所有结果都满足时，返回结果true;思考清楚了，代码真是呼之欲出。

大概设计了下接口如下：

/**
 * 
 * @author XuNeverMore
 * @QQ 1045530120
 * @create on 2018/2/2 0002
 * @github https://github.com/XuNeverMore
 */

public interface IContentChecker {


    /**
     * 检查条件
     */
    public interface Condition{
        /**
         * 是否符合条件
         * @param body
         * @return
         */
        boolean match(Body body);

        void showTips(Body body);

    }


    /**
     * 被检查的内容
     */
    public interface Body{

        /**
         * 被检查内容的名字
         * @return
         */
        CharSequence getName();

        /**
         * 被检查的具体内容
         * @return
         */
        CharSequence getContent();

    }

    boolean check(Body body, List<Condition>conditions);

}

OK,下面就是具体的实现了，为了简单易用那肯定要支持链式调用。

ContentBody(检查内容实现类)

public class ContentBody implements IContentChecker.Body {

    private String name;
    private String content;

    public ContentBody(String name, String content) {
        this.name = name;
        this.content = content;
    }

    @Override
    public CharSequence getName() {
        return name;
    }

    @Override
    public CharSequence getContent() {
        return content;
    }
}

BaseCondition 具体的条件自己去实现

public abstract class BaseCondition implements IContentChecker.Condition {



    @Override
    public void showTips(IContentChecker.Body body) {

    }
}

内容检查器，初步。

ContentChecker

/**
 * 内容检查工具类
 *
 * @author XuNeverMore
 * @QQ 1045530120
 * @create on 2018/2/2 0002
 * @github https://github.com/XuNeverMore
 */

public class ContentChecker implements IContentChecker {

    private ContentChecker() {

    }


    private Body body;
    private List<Condition> conditionList;

    private ContentChecker(Body body) {
        this.body = body;
    }

    public static ContentChecker getChecker(Body body){

        return new ContentChecker(body);
    }

    /**
     * 添加条件
     * @param condition
     * @return
     */
    public ContentChecker addCondition(Condition condition){
        if(conditionList == null){
            conditionList = new ArrayList<>();
        }
        conditionList.add(condition);

        return this;
    }

/**
     * 检查条件并返回检查结果
     * @return
     */
    public boolean getCheckResult(){

        if(this.body == null||this.conditionList==null){
            throw new NullPointerException("检查内容和条件不能为空");
        }

        return check(this.body,this.conditionList);
    }


    @Override
    public boolean check(@NonNull Body body, @NonNull List<Condition> conditions) {

        for (Condition c : conditions) {
            if (!c.match(body)) {
                c.showTips(body);
                return false;
            }
        }
        return true;
    }


}

用法

简单的一个例子判断手机号不能空并且符合手机号规则的。

ContentBody phoneNumBody = new ContentBody("手机号", phoneNum);
boolean checkResult = ContentChecker.getChecker(phoneNumBody)
                    .addCondition(new BaseCondition() {
                        @Override
                        public boolean match(IContentChecker.Body body) {

                            return RegexUtils.isMobileExact(phoneNum);
                        }

                        @Override
                        public void showTips(IContentChecker.Body body) {
                            ToastUtils.showShort(body.getName() + "不正确！");
                        }
                    })
                    .addCondition(new BaseCondition() {
                        @Override
                        public boolean match(IContentChecker.Body body) {
                            return TextUtils.isEmpty(body.getContent());
                        }

                        @Override
                        public void showTips(IContentChecker.Body body) {
                            ToastUtils.showShort(body.getName()+"手机号不能为空");
                        }
                    })
                    .getCheckResult();

自我感觉看起来还不错链式调用，结构清晰，比if判断好些。每个条件每次得实现还是比较繁琐，我们可以把常用的都实现了，然后用的时候直接new就行了。下面是用实现过了条件类写的，更简单明了。条件有必要的话可以用单例模式搞出来。

 ContentBody phoneNumBody = new ContentBody("手机号", phoneNum);

            boolean checkResult = ContentChecker.getChecker(phoneNumBody)
                    .addCondition(new NonNullCondition())
                    .addCondition(new PhoneNumCondition())
                    .getCheckResult();

现在基本上解决了用if检查的繁琐了，还有一个问题就是检查多个的内容需要一点点优化。所以我写了一个内部内来解决多个内容检查的问题。

ContentChecker.Machine 用于多项内容检查

public class ContentChecker implements IContentChecker {

    private ContentChecker() {

    }

    private Body body;
    private List<Condition> conditionList;

    private ContentChecker(Body body) {
        this.body = body;
    }

    public static ContentChecker getChecker(Body body){

        return new ContentChecker(body);
    }

    public ContentChecker addCondition(Condition condition){
        if(conditionList == null){
            conditionList = new ArrayList<>();
        }
        conditionList.add(condition);

        return this;
    }

    /**
     * 检查条件并返回检查结果
     * @return
     */
    public boolean getCheckResult(){

        if(this.body == null||this.conditionList==null){
            throw new NullPointerException("检查内容和条件不能为空");
        }

        return check(this.body,this.conditionList);
    }

    @Override
    public boolean check(@NonNull Body body, @NonNull List<Condition> conditions) {

        for (Condition c : conditions) {
            if (!c.match(body)) {
                c.showTips(body);
                return false;
            }
        }
        return true;
    }


    public static Machine getCheckMachine(){
        return new Machine();
    }

    public static class Machine{

        private List<ContentChecker> checkerList;

        private Machine() {
            checkerList = new ArrayList<>();
        }

        public Machine putChecker(ContentChecker checker){
            checkerList.add(checker);
            return this;
        }

        /**
         * 检查所有内容
         * @return 结果
         */
        public boolean checkAll(){

            for(ContentChecker c:checkerList){
                if(!c.getCheckResult()){
                    return false;
                }
            }
            return true;
        }
    }

}

那么现在我检查手机号和密码就是这样写的了。

            String phoneNum = mDataBing.edtPhone.getText().toString().trim();
            String password = mDataBing.edtPassword.getText().toString().trim();
            ContentBody phoneNumBody = new ContentBody("手机号", phoneNum);

            ContentBody passwordBody = new ContentBody("密码", password);
            boolean result = ContentChecker.getCheckMachine()
                    .putChecker(ContentChecker.getChecker(phoneNumBody)
                            .addCondition(new NonNullCondition())
                            .addCondition(new PhoneNumCondition()))
                    .putChecker(ContentChecker.getChecker(passwordBody)
                            .addCondition(new NonNullCondition())
                            .addCondition(new BaseCondition() {
                                @Override
                                public boolean match(IContentChecker.Body body) {
                                    return body.getContent().length() >= 6;
                                }
                                @Override
                                public void showTips(IContentChecker.Body body) {
                                    ToastUtils.showShort("密码不能少于6位");
                                }
                            }))
                    .checkAll();

result就是检查手机号和密码最后的结果。

以下是几个常见的检查条件

/**
 * 非空条件
 * @author XuNeverMore
 * @QQ 1045530120
 * @create on 2018/2/2 0002
 * @github https://github.com/XuNeverMore
 */

public class NonNullCondition extends BaseCondition{
    
    @Override
    public boolean match(IContentChecker.Body body) {
        return !TextUtils.isEmpty(body.getContent());
    }

    @Override
    public void showTips(IContentChecker.Body body) {
        //因为这里取得是body.getName()所以手机号或密码为空的提示，该类都适用
        ToastUtils.showShort(body.getName()+"不能为空！");
    }
}


/**
 * 内容长度检查条件
 * @author XuNeverMore
 * @QQ 1045530120
 * @create on 2018/2/2 0002
 * @github https://github.com/XuNeverMore
 */

public class LengthCondition implements IContentChecker.Condition{


    private int length;//最小长度

    public LengthCondition(int length) {
        this.length = length;
    }

    @Override
    public boolean match(IContentChecker.Body body) {
        return !TextUtils.isEmpty(body.getContent())&&body.getContent().length()>=length;
    }

    @Override
    public void showTips(IContentChecker.Body body) {

        ToastUtils.showShort(body.getName()+"长度不能少于"+length+"位");
    }
}

github源码