用建造者模式實現(xiàn)一個防SQL注入的ORM框架

本文節(jié)選自《設計模式就該這樣學》

1 建造者模式的鏈式寫法

以構建一門課程為例糊肠,一個完整的課程由PPT課件、回放視頻、課堂筆記韭寸、課后作業(yè)組成,但是這些內(nèi)容的設置順序可以隨意調(diào)整荆隘,我們用建造者模式來代入理解一下恩伺。首先創(chuàng)建一個產(chǎn)品類Course。


@Data
public class Course {

    private String name;
    private String ppt;
    private String video;
    private String note;

    private String homework;

    @Override
    public String toString() {
        return "CourseBuilder{" +
                "name='" + name + '\'' +
                ", ppt='" + ppt + '\'' +
                ", video='" + video + '\'' +
                ", note='" + note + '\'' +
                ", homework='" + homework + '\'' +
                '}';
    }
}

然后創(chuàng)建建造者類CourseBuilder椰拒,將復雜的創(chuàng)建過程封裝起來晶渠,創(chuàng)建步驟由用戶決定。


public class CourseBuilder {

    private Course course = new Course();

    public CourseBuilder addName(String name){
        course.setName(name);
        return this;
    }

    public CourseBuilder addPpt(String ppt){
        course.setPpt(ppt);
        return this;
    }

    public CourseBuilder addVideo(String video){
        course.setVideo(video);
        return this;
    }

    public CourseBuilder addNote(String note){
        course.setNote(note);
        return this;
    }

    public CourseBuilder addHomework(String homework){
        course.setHomework(homework);
        return this;
    }

    public Course builder(){
        return course;
    }

}

最后編寫客戶端測試代碼燃观。



    public static void main(String[] args) {
        CourseBuilder builder = new CourseBuilder()
                    .addName("設計模式")
                    .addPPT("【PPT課件】")
                    .addVideo("【回放視頻】")
                    .addNote("【課堂筆記】")
                    .addHomework("【課后作業(yè)】");

        System.out.println(builder.build());
}

這樣的寫法是不是很眼熟褒脯?后面分析建造者模式在框架源碼中的應用時大家就會明白。再來看一下類圖的變化仪壮,如下圖所示憨颠。

file

2 使用靜態(tài)內(nèi)部類實現(xiàn)建造者模式

事實上,在平常的編碼中积锅,我們通常都會忽略對象的復雜性爽彤,優(yōu)先考慮使用工廠模式創(chuàng)建對象,而不是建造者模式缚陷。因為工廠模式和建造者模式的作用都是創(chuàng)建一個產(chǎn)品對象适篙,而工廠模式的結構更加簡潔直接(沒有Builder和 Director),因此更常使用箫爷。
一般情況下嚷节,我們更習慣使用靜態(tài)內(nèi)部類的方式實現(xiàn)建造者模式,即一個產(chǎn)品類內(nèi)部自動帶有一個具體建造者虎锚,由它負責該產(chǎn)品的組裝創(chuàng)建硫痰,不再需要Builder和Director,這樣窜护,產(chǎn)品表示與創(chuàng)建之間的聯(lián)系更加緊密效斑,結構更加緊湊,同時使得建造者模式的形式更加簡潔柱徙。
如果采用靜態(tài)內(nèi)部類形式實現(xiàn)建造者模式缓屠,則前面的案例可以改寫如下奇昙。



@Data
public class Course {
    private String name;
    private String ppt;
    private String video;
    private String note;

    private String homework;

    @Override
    public String toString() {
        return "Course{" +
                "name='" + name + '\'' +
                ", ppt='" + ppt + '\'' +
                ", video='" + video + '\'' +
                ", note='" + note + '\'' +
                ", homework='" + homework + '\'' +
                '}';
    }

    public static class Builder {

        private Course course = new Course();

        public Builder addName(String name){
            course.setName(name);
            return this;
        }

        public Builder addPpt(String ppt){
            course.setPpt(ppt);
            return this;
        }

        public Builder addVideo(String video){
            course.setVideo(video);
            return this;
        }

        public Builder addNote(String note){
            course.setNote(note);
            return this;
        }

        public Builder addHomework(String homework){
            course.setHomework(homework);
            return this;
        }

        public Course builder(){
            return course;
        }

    }
}

客戶端測試代碼如下。



    public static void main(String[] args) {
         Course course = new Course.Builder()
                .addName("設計模式")
                .addPpt("【PPT課件】")
                .addVideo("【錄播視頻】")
                 .builder();

        System.out.println(course);
    }
        

這樣敌完,代碼也會看上去更加簡潔储耐,不會讓人感覺到多了一個類。

3 使用建造者模式動態(tài)構建SQL語句

下面來看一個實戰(zhàn)案例滨溉,這個案例參考了開源框架JPA的SQL構造模式什湘。我們在構造SQL查詢條件的時候,需要根據(jù)不同的條件來拼接SQL字符串晦攒。如果查詢條件復雜禽炬,則SQL拼接的過程也會變得非常復雜,從而給代碼維護帶來非常大的困難勤家。因此,我們用建造者類QueryRuleSqlBuilder將復雜的SQL構造過程進行封裝柳恐,用QueryRule對象專門保存SQL查詢時的條件伐脖,最后根據(jù)查詢條件,自動生成SQL語句乐设。首先創(chuàng)建QueryRule類讼庇,代碼如下。


import java.io.Serializable;
import java.util.ArrayList;
import java.util.List;

/**
 * QueryRule近尚,主要功能用于構造查詢條件
 * 
 * @author Tom
 */
public final class QueryRule implements Serializable
{
    private static final long serialVersionUID = 1L;
    public static final int ASC_ORDER = 101;
    public static final int DESC_ORDER = 102;
    public static final int LIKE = 1;
    public static final int IN = 2;
    public static final int NOTIN = 3;
    public static final int BETWEEN = 4;
    public static final int EQ = 5;
    public static final int NOTEQ = 6;
    public static final int GT = 7;
    public static final int GE = 8;
    public static final int LT = 9;
    public static final int LE = 10;
    public static final int ISNULL = 11;
    public static final int ISNOTNULL = 12;
    public static final int ISEMPTY = 13;
    public static final int ISNOTEMPTY = 14;
    public static final int AND = 201;
    public static final int OR = 202;
    private List<Rule> ruleList = new ArrayList<Rule>();
    private List<QueryRule> queryRuleList = new ArrayList<QueryRule>();
    private String propertyName;

    private QueryRule() {}

    private QueryRule(String propertyName) {
        this.propertyName = propertyName;
    }

    public static QueryRule getInstance() {
        return new QueryRule();
    }
    
    /**
     * 添加升序規(guī)則
     * @param propertyName
     * @return
     */
    public QueryRule addAscOrder(String propertyName) {
        this.ruleList.add(new Rule(ASC_ORDER, propertyName));
        return this;
    }

    /**
     * 添加降序規(guī)則
     * @param propertyName
     * @return
     */
    public QueryRule addDescOrder(String propertyName) {
        this.ruleList.add(new Rule(DESC_ORDER, propertyName));
        return this;
    }

    public QueryRule andIsNull(String propertyName) {
        this.ruleList.add(new Rule(ISNULL, propertyName).setAndOr(AND));
        return this;
    }

    public QueryRule andIsNotNull(String propertyName) {
        this.ruleList.add(new Rule(ISNOTNULL, propertyName).setAndOr(AND));
        return this;
    }

    public QueryRule andIsEmpty(String propertyName) {
        this.ruleList.add(new Rule(ISEMPTY, propertyName).setAndOr(AND));
        return this;
    }

    public QueryRule andIsNotEmpty(String propertyName) {
        this.ruleList.add(new Rule(ISNOTEMPTY, propertyName).setAndOr(AND));
        return this;
    }

    public QueryRule andLike(String propertyName, Object value) {
        this.ruleList.add(new Rule(LIKE, propertyName, new Object[] { value }).setAndOr(AND));
        return this;
    }

    public QueryRule andEqual(String propertyName, Object value) {
        this.ruleList.add(new Rule(EQ, propertyName, new Object[] { value }).setAndOr(AND));
        return this;
    }

    public QueryRule andBetween(String propertyName, Object... values) {
        this.ruleList.add(new Rule(BETWEEN, propertyName, values).setAndOr(AND));
        return this;
    }

    public QueryRule andIn(String propertyName, List<Object> values) {
        this.ruleList.add(new Rule(IN, propertyName, new Object[] { values }).setAndOr(AND));
        return this;
    }

    public QueryRule andIn(String propertyName, Object... values) {
        this.ruleList.add(new Rule(IN, propertyName, values).setAndOr(AND));
        return this;
    }
    
    public QueryRule andNotIn(String propertyName, List<Object> values) {
        this.ruleList.add(new Rule(NOTIN, 
                                    propertyName, 
                                    new Object[] { values }).setAndOr(AND));
        return this;
    }

    //此處省略部分代碼
    

    public List<Rule> getRuleList() {
        return this.ruleList;
    }

    public List<QueryRule> getQueryRuleList() {
        return this.queryRuleList;
    }

    public String getPropertyName() {
        return this.propertyName;
    }

    protected class Rule implements Serializable {
        private static final long serialVersionUID = 1L;
        private int type;   //規(guī)則的類型
        private String property_name;
        private Object[] values;
        private int andOr = AND;

        public Rule(int paramInt, String paramString) {
            this.property_name = paramString;
            this.type = paramInt;
        }

        public Rule(int paramInt, String paramString,
                Object[] paramArrayOfObject) {
            this.property_name = paramString;
            this.values = paramArrayOfObject;
            this.type = paramInt;
        }
        
        public Rule setAndOr(int andOr){
            this.andOr = andOr;
            return this;
        }
        
        public int getAndOr(){
            return this.andOr;
        }

        public Object[] getValues() {
            return this.values;
        }

        public int getType() {
            return this.type;
        }

        public String getPropertyName() {
            return this.property_name;
        }
    }
}

然后創(chuàng)建QueryRuleSqlBuilder類蠕啄。


package com.tom.vip.pattern.builder.sql;


/**
 * 根據(jù)QueryRule自動構建SQL語句
 * @author Tom
 *
 */
public class QueryRuleSqlBuilder {
    private int CURR_INDEX = 0; //記錄參數(shù)所在的位置
    private List<String> properties; //保存列名列表
    private List<Object> values; //保存參數(shù)值列表
    private List<Order> orders; //保存排序規(guī)則列表
    
    private String whereSql = ""; 
    private String orderSql = "";
    private Object [] valueArr = new Object[]{};
    private Map<Object,Object> valueMap = new HashMap<Object,Object>();
    
    /**
     * 獲得查詢條件
     * @return
     */
    private String getWhereSql(){
        return this.whereSql;
    }
    
    /**
     * 獲得排序條件
     * @return
     */
    private String getOrderSql(){
        return this.orderSql;
    }
    
    /**
     * 獲得參數(shù)值列表
     * @return
     */
    public Object [] getValues(){
        return this.valueArr;
    }
    
    /**
     * 獲得參數(shù)列表
     * @return
     */
    private Map<Object,Object> getValueMap(){
        return this.valueMap;
    }
    
    /**
     * 創(chuàng)建SQL構造器
     * @param queryRule
     */
    public QueryRuleSqlBuilder(QueryRule queryRule) {
        CURR_INDEX = 0;
        properties = new ArrayList<String>();
        values = new ArrayList<Object>();
        orders = new ArrayList<Order>();
        for (QueryRule.Rule rule : queryRule.getRuleList()) {
            switch (rule.getType()) {
            case QueryRule.BETWEEN:
                processBetween(rule);
                break;
            case QueryRule.EQ:
                processEqual(rule);
                break;
            case QueryRule.LIKE:
                processLike(rule);
                break;
            case QueryRule.NOTEQ:
                processNotEqual(rule);
                break;
            case QueryRule.GT:
                processGreaterThen(rule);
                break;
            case QueryRule.GE:
                processGreaterEqual(rule);
                break;
            case QueryRule.LT:
                processLessThen(rule);
                break;
            case QueryRule.LE:
                processLessEqual(rule);
                break;
            case QueryRule.IN:
                processIN(rule);
                break;
            case QueryRule.NOTIN:
                processNotIN(rule);
                break;
            case QueryRule.ISNULL:
                processIsNull(rule);
                break;
            case QueryRule.ISNOTNULL:
                processIsNotNull(rule);
                break;
            case QueryRule.ISEMPTY:
                processIsEmpty(rule);
                break;
            case QueryRule.ISNOTEMPTY:
                processIsNotEmpty(rule);
                break;
            case QueryRule.ASC_ORDER:
                processOrder(rule);
                break;
            case QueryRule.DESC_ORDER:
                processOrder(rule);
                break;
            default:
                throw new IllegalArgumentException("type"+rule.getType()+"not supported.");
            }
        }
        //拼裝where語句
        appendWhereSql();
        //拼裝排序語句
        appendOrderSql();
        //拼裝參數(shù)值
        appendValues();
    }
    
    /**
     * 去掉order
     * 
     * @param sql
     * @return
     */
    private String removeOrders(String sql) {
        Pattern p = Pattern.compile("order\\s*by[\\w|\\W|\\s|\\S]*", Pattern.CASE_INSENSITIVE);
        Matcher m = p.matcher(sql);
        StringBuffer sb = new StringBuffer();
        while (m.find()) {
            m.appendReplacement(sb, "");
        }
        m.appendTail(sb);
        return sb.toString();
    }
    
    /**
     * 去掉select
     * 
     * @param sql
     * @return
     */
    private String removeSelect(String sql) {
        if(sql.toLowerCase().matches("from\\s+")){
            int beginPos = sql.toLowerCase().indexOf("from");
            return sql.substring(beginPos);
        }else{
            return sql;
        }
    }
    
    /**
     * 處理like
     * @param rule
     */
    private  void processLike(QueryRule.Rule rule) {
        if (ArrayUtils.isEmpty(rule.getValues())) {
            return;
        }
        Object obj = rule.getValues()[0];

        if (obj != null) {
            String value = obj.toString();
            if (!StringUtils.isEmpty(value)) {
                value = value.replace('*', '%');
                obj = value;
            }
        }
        add(rule.getAndOr(),rule.getPropertyName(),"like","%"+rule.getValues()[0]+"%");
    }

    /**
     * 處理between
     * @param rule
     */
    private  void processBetween(QueryRule.Rule rule) {
        if ((ArrayUtils.isEmpty(rule.getValues()))
                || (rule.getValues().length < 2)) {
            return;
        }
        add(rule.getAndOr(),rule.getPropertyName(),"","between",rule.getValues()[0],"and");
        add(0,"","","",rule.getValues()[1],"");
    }
    

//此處省略部分代碼
    
    
    /**
     * 加入SQL查詢規(guī)則隊列
     * @param andOr and或者or
     * @param key 列名
     * @param split 列名與值之間的間隔
     * @param value 值
     */
    private  void add(int andOr,String key,String split ,Object value){
        add(andOr,key,split,"",value,"");
    }
    
    /**
     * 加入SQL查詢規(guī)則隊列
     * @param andOr and或者or
     * @param key 列名
     * @param split 列名與值之間的間隔
     * @param prefix 值前綴
     * @param value 值
     * @param suffix 值后綴
     */
    private  void add(int andOr,String key,String split ,String prefix,Object value,String      suffix){
        String andOrStr = (0 == andOr ? "" :(QueryRule.AND == andOr ? " and " : " or "));  
        properties.add(CURR_INDEX, 
         andOrStr + key + " " + split + prefix + (null != value ? " ? " : " ") + suffix);
        if(null != value){
            values.add(CURR_INDEX,value);
            CURR_INDEX ++;
        }
    }
    
    
    /**
     * 拼裝where語句
     */
    private void appendWhereSql(){
        StringBuffer whereSql = new StringBuffer();
        for (String p : properties) {
            whereSql.append(p);
        }
        this.whereSql = removeSelect(removeOrders(whereSql.toString()));
    }
    
    /**
     * 拼裝排序語句
     */
    private void appendOrderSql(){
        StringBuffer orderSql = new StringBuffer();
        for (int i = 0 ; i < orders.size(); i ++) {
            if(i > 0 && i < orders.size()){
                orderSql.append(",");
            }
            orderSql.append(orders.get(i).toString());
        }
        this.orderSql = removeSelect(removeOrders(orderSql.toString()));
    }
    
    /**
     * 拼裝參數(shù)值
     */
    private void appendValues(){
        Object [] val = new Object[values.size()];
        for (int i = 0; i < values.size(); i ++) {
            val[i] = values.get(i);
            valueMap.put(i, values.get(i));
        }
        this.valueArr = val;
    }

    public String builder(String tableName){
        String ws = removeFirstAnd(this.getWhereSql());
        String whereSql = ("".equals(ws) ? ws : (" where " + ws));
        String sql = "select * from " + tableName + whereSql;
        Object [] values = this.getValues();
        String orderSql = this.getOrderSql();
        orderSql = (StringUtils.isEmpty(orderSql) ? " " : (" order by " + orderSql));
        sql += orderSql;
        return sql;
    }


    private String removeFirstAnd(String sql){
        if(StringUtils.isEmpty(sql)){return sql;}
        return sql.trim().toLowerCase().replaceAll("^\\s*and", "") + " ";
    }

}

接著創(chuàng)建Order類。


/**
 * SQL排序組件
 * @author Tom
 */
public class Order {
    private boolean ascending; //升序還是降序
    private String propertyName; //哪個字段升序戈锻,哪個字段降序
    
    public String toString() {
        return propertyName + ' ' + (ascending ? "asc" : "desc");
    }

    /**
     * Constructor for Order.
     */
    protected Order(String propertyName, boolean ascending) {
        this.propertyName = propertyName;
        this.ascending = ascending;
    }

    /**
     * Ascending order
     *
     * @param propertyName
     * @return Order
     */
    public static Order asc(String propertyName) {
        return new Order(propertyName, true);
    }

    /**
     * Descending order
     *
     * @param propertyName
     * @return Order
     */
    public static Order desc(String propertyName) {
        return new Order(propertyName, false);
    }

}

最后編寫客戶端測試代碼歼跟。


public static void main(String[] args) {
        QueryRule queryRule = QueryRule.getInstance();
        queryRule.addAscOrder("age");
        queryRule.andEqual("addr","Changsha");
        queryRule.andLike("name","Tom");
        QueryRuleSqlBuilder builder = new QueryRuleSqlBuilder(queryRule);

        System.out.println(builder.builder("t_member"));

        System.out.println("Params: " + Arrays.toString(builder.getValues()));


}

這樣一來,客戶端代碼就非常清楚格遭,運行結果如下圖所示哈街。

file

關注『 Tom彈架構 』回復“設計模式”可獲取完整源碼。

【推薦】Tom彈架構:30個設計模式真實案例拒迅,挑戰(zhàn)年薪60W不是夢

本文為“Tom彈架構”原創(chuàng)骚秦,轉載請注明出處。技術在于分享璧微,我分享我快樂作箍!
如果本文對您有幫助,歡迎關注和點贊前硫;如果您有任何建議也可留言評論或私信胞得,您的支持是我堅持創(chuàng)作的動力。關注『 Tom彈架構 』可獲取更多技術干貨开瞭!

最后編輯于
?著作權歸作者所有,轉載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末懒震,一起剝皮案震驚了整個濱河市罩息,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌个扰,老刑警劉巖瓷炮,帶你破解...
    沈念sama閱讀 212,816評論 6 492
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異递宅,居然都是意外死亡娘香,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 90,729評論 3 385
  • 文/潘曉璐 我一進店門办龄,熙熙樓的掌柜王于貴愁眉苦臉地迎上來烘绽,“玉大人,你說我怎么就攤上這事俐填“步樱” “怎么了?”我有些...
    開封第一講書人閱讀 158,300評論 0 348
  • 文/不壞的土叔 我叫張陵英融,是天一觀的道長盏檐。 經(jīng)常有香客問我,道長驶悟,這世上最難降的妖魔是什么胡野? 我笑而不...
    開封第一講書人閱讀 56,780評論 1 285
  • 正文 為了忘掉前任,我火速辦了婚禮痕鳍,結果婚禮上硫豆,老公的妹妹穿的比我還像新娘。我一直安慰自己笼呆,他們只是感情好熊响,可當我...
    茶點故事閱讀 65,890評論 6 385
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著诗赌,像睡著了一般耘眨。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上境肾,一...
    開封第一講書人閱讀 50,084評論 1 291
  • 那天剔难,我揣著相機與錄音,去河邊找鬼奥喻。 笑死偶宫,一個胖子當著我的面吹牛,可吹牛的內(nèi)容都是我干的环鲤。 我是一名探鬼主播纯趋,決...
    沈念sama閱讀 39,151評論 3 410
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了吵冒?” 一聲冷哼從身側響起纯命,我...
    開封第一講書人閱讀 37,912評論 0 268
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎痹栖,沒想到半個月后亿汞,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 44,355評論 1 303
  • 正文 獨居荒郊野嶺守林人離奇死亡揪阿,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 36,666評論 2 327
  • 正文 我和宋清朗相戀三年疗我,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片南捂。...
    茶點故事閱讀 38,809評論 1 341
  • 序言:一個原本活蹦亂跳的男人離奇死亡吴裤,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出溺健,到底是詐尸還是另有隱情麦牺,我是刑警寧澤,帶...
    沈念sama閱讀 34,504評論 4 334
  • 正文 年R本政府宣布鞭缭,位于F島的核電站枕面,受9級特大地震影響,放射性物質發(fā)生泄漏缚去。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 40,150評論 3 317
  • 文/蒙蒙 一琼开、第九天 我趴在偏房一處隱蔽的房頂上張望易结。 院中可真熱鬧,春花似錦柜候、人聲如沸搞动。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,882評論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽鹦肿。三九已至,卻和暖如春辅柴,著一層夾襖步出監(jiān)牢的瞬間箩溃,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 32,121評論 1 267
  • 我被黑心中介騙來泰國打工碌嘀, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留涣旨,地道東北人。 一個月前我還...
    沈念sama閱讀 46,628評論 2 362
  • 正文 我出身青樓股冗,卻偏偏與公主長得像霹陡,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 43,724評論 2 351

推薦閱讀更多精彩內(nèi)容