All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.nutz.spring.boot.service.ExtService Maven / Gradle / Ivy

There is a newer version: 3.4.1
Show newest version
package org.nutz.spring.boot.service;

import java.io.Serializable;
import java.lang.reflect.Field;
import java.util.List;

import org.nutz.dao.Chain;
import org.nutz.dao.Cnd;
import org.nutz.dao.Condition;
import org.nutz.dao.Dao;
import org.nutz.dao.FieldFilter;
import org.nutz.dao.FieldMatcher;
import org.nutz.dao.Sqls;
import org.nutz.dao.entity.Entity;
import org.nutz.dao.entity.Record;
import org.nutz.dao.entity.annotation.Id;
import org.nutz.dao.entity.annotation.Name;
import org.nutz.dao.sql.Sql;
import org.nutz.dao.util.cri.Exps;
import org.nutz.dao.util.cri.SqlExpressionGroup;
import org.nutz.lang.Lang;
import org.nutz.lang.Mirror;
import org.nutz.lang.Strings;
import org.nutz.lang.util.NutMap;
import org.nutz.log.Logs;
import org.nutz.spring.boot.cnd.OrderBy;
import org.nutz.spring.boot.service.entity.Pagination;

/**
 * 
 * @author kerbores([email protected])
 */
public interface ExtService {
    static final String EQ = "=";
    static final String NEQ = "!=";
    static final String LT = "<";
    static final String GT = ">";
    static final String IS = "is";
    static final String IS_NOT = "is not";
    static final String NOT = "not";
    static final String LIKE = "like";
    static final String IN = "in";
    static final String LT_AND_EQ = "<=";
    static final String GT_AND_EQ = ">=";

    /**
     * 获取dao实例
     * 
     * @return dao实例
     */
    Dao dao();

    /**
     * 根据条件查询列表
     * 
     * @param cnd
     *            条件
     * @return 数据列表
     */
    List query(Condition cnd);

    /**
     * 获取泛型类型class
     * 
     * @return 泛型class
     */
    Class getEntityType();

    /**
     * 根据条件删除
     * 
     * @param cnd
     *            条件
     * @return 删除的数据记录数
     */
    int clear(Condition cnd);

    /**
     * 获取泛型的Entity描述
     * 
     * @return Entity描述
     */
    Entity getEntity();

    /**
     * 根据条件进行分页查询
     * 
     * @param cnd
     *            条件
     * @param pager
     *            分页
     * @return 数据列表
     */
    List query(Condition cnd, org.nutz.dao.pager.Pager pager);

    /**
     * 根据条件进行计数
     * 
     * @param cnd
     *            条件
     * @return 数量
     */
    int count(Condition cnd);

    /**
     * 默认分页大小
     * 
     * @return 分页大小,默认15
     */
    default int getDefaultPageSize() {
        return 15;
    }

    /**
     * 保存实体
     *
     * @param t
     *            待保存实体
     * @return 保存后的实体, 根据配置可能将产生 id 等其他属性
     */
    default T insert(T t) {
        return dao().insert(t);
    }

    /**
     * 保存数据
     * 
     * @param ts
     *            数据列表
     * @return 存入后的数据列表,结果返回 @see {@link Dao#fastInsert(Object)}
     * 
     */
    default List insert(List ts) {
        return dao().fastInsert(ts);
    }

    /**
     * 保存对象指定字段
     *
     * @param obj
     *            待保存对象
     * @param filter
     *            字段过滤器
     * @return 保存后的对象
     */
    default T save(final T obj, FieldFilter filter) {
        return dao().insert(obj, filter);
    }

    /**
     * 保存
     *
     * @param tableName
     *            表名
     * @param chain
     *            数据链
     */
    default void save(String tableName, Chain chain) {
        dao().insert(tableName, chain);
    }

    /**
     * 保存
     *
     * @param classOfT
     *            类
     * @param chain
     *            数据链
     */
    default void save(Class classOfT, Chain chain) {
        dao().insert(classOfT, chain);
    }

    /**
     * 保存
     *
     * @param t
     *            数据对象
     * @param ignoreNull
     *            是否忽略空值
     * @param ignoreZero
     *            是否忽略零值
     * @param ignoreBlankStr
     *            是否忽略空字符串
     * @return 保存后的对象
     */
    default T save(final T t, boolean ignoreNull, boolean ignoreZero, boolean ignoreBlankStr) {
        return dao().insert(t, ignoreNull, ignoreZero, ignoreBlankStr);
    }

    /**
     * 保存指定字段
     *
     * @param obj
     *            待保存对象
     * @param regex
     *            字段正则
     * @return 保存后的对象
     */
    default T insertWith(T obj, String regex) {
        return dao().insertWith(obj, regex);
    }

    /**
     * 保存关联数据
     *
     * @param obj
     *            对象
     * @param regex
     *            管理字段正则
     * @return 保存后的对象
     */
    default T insertLinks(T obj, String regex) {
        return dao().insertLinks(obj, regex);
    }

    /**
     * 插入中间表
     *
     * @param obj
     *            对象
     * @param regex
     *            正则
     * @return 保存后的对象
     */
    default T insertRelation(T obj, String regex) {
        return dao().insertRelation(obj, regex);
    }

    /**
     * 查询全部
     *
     * @return 对象列表
     */
    default List all() {
        return query(null);
    }

    /**
     * 根据条件查询
     * 
     * @param cnd
     *            条件
     * @return 对象列表
     */
    default List list(Condition cnd) {
        return query(cnd);
    }

    /**
     * 分页查询
     *
     * @param condition
     *            条件
     * @param currentPage
     *            当前页码
     * @param pageSize
     *            页面大小
     * @return 对象列表
     */
    default List list(Condition condition, int currentPage, int pageSize) {
        return dao().query(getEntityType(), condition, dao().createPager(currentPage, pageSize));
    }

    /**
     * 分页查询
     *
     * @param condition
     *            条件
     * @param currentPage
     *            页码
     * @return 对象列表
     */
    default List list(Condition condition, int currentPage) {
        return list(condition, currentPage, getDefaultPageSize());
    }

    /**
     * 执行sql并返回对象列表
     * 
     * @param sql
     *            待执行sql
     * @return 对象列表
     */
    default List list(Sql sql) {
        return list(sql, getEntityType());
    }

    /**
     * 执行sql并返回对象列表
     * 
     * @param 
     *            类型泛型
     * @param sql
     *            待执行sql
     * @param clazz
     *            返回的类型
     * @return 对象列表
     */
    default  List list(Sql sql, Class clazz) {
        sql.setCallback(Sqls.callback.entities());
        sql.setEntity(dao().getEntity(clazz));
        dao().execute(sql);
        return sql.getList(clazz);
    }

    /**
     * 执行sql并返回记录列表
     * 
     * @param sql
     *            待执行sql
     * @return 数据记录列表
     */
    default List listAsRecord(Sql sql) {
        sql.setCallback(Sqls.callback.records());
        dao().execute(sql);
        return sql.getList(Record.class);
    }

    /**
     * 执行sql并返回单个字符串字段列表
     * 
     * @param sql
     * @return
     */
    default List listAsString(Sql sql) {
        sql.setCallback(Sqls.callback.strList());
        dao().execute(sql);
        return sql.getList(String.class);
    }

    /**
     * 执行sql并返回单个Integer字段列表
     * 
     * @param sql
     * @return
     */
    default List listAsInteger(Sql sql) {
        sql.setCallback(Sqls.callback.ints());
        dao().execute(sql);
        return sql.getList(int.class);
    }

    /**
     * 执行sql并返回单个Long字段列表
     * 
     * @param sql
     * @return
     */
    default List listAsLong(Sql sql) {
        sql.setCallback(Sqls.callback.longs());
        dao().execute(sql);
        return sql.getList(long.class);
    }

    /**
     * 执行sql并返回单个Boolean字段列表
     * 
     * @param sql
     * @return
     */
    default List listAsBoolean(Sql sql) {
        sql.setCallback(Sqls.callback.bools());
        dao().execute(sql);
        return sql.getList(boolean.class);
    }

    /**
     * 执行sql并返回map列表,列别名作为key
     * 
     * @param sql
     *            待执行sql
     * @return 数据记录列表
     */
    default List listAsMap(Sql sql) {
        sql.setCallback(Sqls.callback.maps());
        dao().execute(sql);
        return sql.getList(NutMap.class);
    }

    /**
     * 根据指定字段查询(仅限唯一属性,非唯一属性返回第一个满足条件的数据)
     *
     * @param field
     *            字段
     * @param value
     *            值
     * @return 单个对象
     */
    default T fetchByField(String field, Object value) {
        return dao().fetch(getEntityType(), Cnd.where(field, EQ, value));
    }

    /**
     * 执行sql并返回记录
     * 
     * @param sql
     *            待执行sql
     * @return 数据记录对象
     */
    default Record fetchAsRecord(Sql sql) {
        sql.setCallback(Sqls.callback.record());
        dao().execute(sql);
        return sql.getObject(Record.class);
    }

    /**
     * 执行sql并返回对象
     * 
     * @param sql
     *            待执行sql
     * @return 数据对象
     */
    default T fetch(Sql sql) {
        return fetch(sql, getEntityType());
    }

    /**
     * 执行sql并返回对象
     * 
     * @param 
     *            对象类型
     * @param sql
     *            待执行sql
     * @param claszz
     *            类型
     * @return 数据对象
     */
    default  E fetch(Sql sql, Class claszz) {
        sql.setCallback(Sqls.callback.entity());
        sql.setEntity(dao().getEntity(claszz));
        dao().execute(sql);
        return sql.getObject(claszz);
    }

    /**
     * 执行删除或者更新语句
     * 
     * @param sql
     *            待执行sql
     * @return 如果当前语句为 DELETE | UPDATE | INSERT,返回执行后所影响的记录数。否则返回 -1
     */
    default int executDeleteOrUpdateSql(Sql sql) {
        sql.setCallback(Sqls.callback.integer());
        dao().execute(sql);
        return sql.getUpdateCount();
    }

    /**
     * 执行count sql
     * 
     * @param sql
     *            待执行sql,请确保sql为count且仅返回一列count数
     * @return 数量
     */
    default int executCountSql(Sql sql) {
        sql.setCallback(Sqls.callback.integer());
        dao().execute(sql);
        return sql.getInt(0);
    }

    /**
     * 分页查询
     *
     * @param page
     *            页码
     * @return 分页数据对象
     */
    default Pagination searchByPage(int page) {
        return searchByPage(page, Cnd.NEW());
    }

    /**
     * 分页查询
     *
     * @param page
     *            页码
     * @param condition
     *            条件
     * @return 分页对象
     */
    default Pagination searchByPage(int page, Condition condition) {
        return searchByPage(page, getDefaultPageSize(), condition);
    }

    /**
     * 根据条件分页查询
     * 
     * @param page
     *            页码
     * @param pageSize
     *            页面大小
     * @param condition
     *            条件
     * @return 分页数据对象
     */
    default Pagination searchByPage(int page, int pageSize, Condition condition) {
        return Pagination. instance(page, pageSize)
                         .dataList(query(condition, new Pagination(page, pageSize)))
                         .recordCount(count(condition));
    }

    /**
     * 分页查询,带排序
     * 
     * @param page
     *            页码
     * @param orderBy
     *            排序
     * @return 分页数据对象
     */
    default Pagination searchByPage(int page, OrderBy orderBy) {
        return searchByPage(page, orderBy.mix(Cnd.NEW()));
    }

    /**
     * 分页查询,带排序
     * 
     * @param page
     *            页码
     * @param pageSize
     *            分页大小
     * @param orderBy
     *            排序
     * @return 分页数据对象
     */
    default Pagination searchByPage(int page, int pageSize, OrderBy orderBy) {
        return searchByPage(page, pageSize, orderBy.mix(Cnd.NEW()));
    }

    /**
     * 分页查询,带排序
     * 
     * @param page
     *            页码
     * @param cnd
     *            条件
     * @param orderBy
     *            排序条件
     * @return 分页数据对象
     */
    default Pagination searchByPage(int page, Cnd cnd, OrderBy orderBy) {
        return searchByPage(page, orderBy.mix(cnd));
    }

    /**
     * 根据条件分页查询,带排序
     * 
     * @param page
     *            页码
     * @param pageSize
     *            页面大小
     * @param cnd
     *            查询条件
     * @param orderBy
     *            排序
     * @return 分页数据对象
     */
    default Pagination searchByPage(int page, int pageSize, Cnd cnd, OrderBy orderBy) {
        return searchByPage(page, pageSize, orderBy.mix(cnd));
    }

    /**
     * 根据条件及关键词进行分页查询
     * 
     * @param key
     *            关键词
     * @param page
     *            页码
     * @param cnd
     *            条件
     * @param fields
     *            关键词匹配的字段列表
     * @return 分页数据对象
     */
    default Pagination searchByKeyAndPage(String key, int page, Cnd cnd, String... fields) {
        return searchByKeyAndPage(key, page, getDefaultPageSize(), cnd, fields);
    }

    /**
     * 根据条件及关键词进行分页查询
     * 
     * @param key
     *            关键词
     * @param page
     *            页码
     * @param pageSize
     *            页面大小
     * @param cnd
     *            条件
     * @param fields
     *            关键词匹配的字段列表
     * @return 分页数据对象
     */
    default Pagination searchByKeyAndPage(String key, int page, int pageSize, Cnd cnd, String... fields) {
        if (cnd == null) {
            cnd = Cnd.NEW();
        }
        SqlExpressionGroup expressionGroup = Exps.begin();
        if (Strings.isNotBlank(key)) {
            String searchKey = String.format("%%%s%%", key);
            int index = 0;
            for (String field : fields) {
                if (index == 0) {
                    expressionGroup.and(field, LIKE, searchKey);
                } else {
                    expressionGroup.or(field, LIKE, searchKey);
                }
                index++;
            }
        }
        return searchByPage(page,
                            pageSize,
                            expressionGroup.getExps() == null || expressionGroup.getExps().isEmpty() ? cnd

                                                                                                     : cnd.and(expressionGroup));
    }

    /**
     * 根据条件及关键词进行分页查询,带排序
     * 
     * @param key
     *            关键词
     * @param page
     *            页码
     * @param orderBy
     *            排序
     * @param fields
     *            关键词匹配的字段列表
     * @return 页数据对象
     */
    default Pagination searchByKeyAndPage(String key, int page, OrderBy orderBy, String... fields) {
        return searchByPage(page, orderBy.mix(Cnd.NEW(), key, fields));
    }

    /**
     * 根据条件及关键词进行分页查询,带排序
     * 
     * @param key
     *            关键词
     * @param page
     *            页码
     * @param cnd
     *            查询条件
     * @param orderBy
     *            排序
     * @param fields
     *            关键词匹配的字段列表
     * @return 页数据对象
     */
    default Pagination searchByKeyAndPage(String key, int page, Cnd cnd, OrderBy orderBy, String... fields) {
        return searchByPage(page, orderBy.mix(cnd, key, fields));
    }

    /**
     * 根据条件及关键词进行分页查询,带排序
     * 
     * @param page
     *            页码
     * @param pageSize
     *            分页大小
     * @param orderBy
     *            排序
     * @param key
     *            关键词
     * @param fields
     *            关键词匹配的字段列表
     * @return 页数据对象
     */
    default Pagination searchByKeyAndPage(int page, int pageSize, OrderBy orderBy, String key, String... fields) {
        return searchByPage(page, pageSize, orderBy.mix(Cnd.NEW(), key, fields));
    }

    /**
     * 根据条件及关键词进行分页查询,带排序
     * 
     * @param key
     *            关键词
     * @param page
     *            页码
     * @param pageSize
     *            分页大小
     * @param cnd
     *            查询条件
     * @param orderBy
     *            排序
     * @param fields
     *            关键词匹配的字段列表
     * @return 页数据对象
     */
    default Pagination searchByKeyAndPage(String key, int page, int pageSize, Cnd cnd, OrderBy orderBy, String... fields) {
        return searchByPage(page, pageSize, orderBy.mix(cnd, key, fields));
    }

    default Pagination searchByKeyAndPage(String key, int page, int pageSize, Condition condition) {
        return searchByPage(page, pageSize, condition);
    }

    /**
     * 关键词搜索
     *
     * @param key
     *            关键词
     * @param page
     *            页码
     * @param pageSize
     *            页面大小
     * @param fields
     *            检索字段列表
     * @return 分页对象
     */
    default Pagination searchByKeyAndPage(String key, int page, int pageSize, String... fields) {
        return searchByKeyAndPage(key, page, pageSize, Cnd.NEW(), fields);
    }

    /**
     * 关键词搜索
     *
     * @param key
     *            关键词
     * @param page
     *            页码
     * @param fields
     *            检索字段列表
     * @return 分页对象
     */
    default Pagination searchByKeyAndPage(String key, int page, String... fields) {
        return searchByKeyAndPage(key, page, getDefaultPageSize(), Cnd.NEW(), fields);
    }

    /**
     * 更新对象
     * 
     * @param obj
     *            待更新对象
     * @return 影响的记录条数
     */
    default int update(T obj) {
        return dao().update(obj);
    }

    /***
     * 更新字段的指定字段
     * 
     * @param obj
     *            待更新对象
     * @param regex
     *            字段正则
     * @return 影响的记录条数
     */
    default int updateFields(final T obj, String regex) {
        return dao().update(obj, regex);
    }

    /**
     * 更新对象的非空字段
     * 
     * @param obj
     *            待更新对象
     * @return 影响的记录条数
     */
    default int updateIgnoreNull(final T obj) {
        return dao().updateIgnoreNull(obj);
    }

    default T updateWith(T obj, final String regex) {
        return dao().updateWith(obj, regex);
    }

    default T updateLinks(T obj, final String regex) {
        return dao().updateLinks(obj, regex);
    }

    /**
     * 更新对象的指定字段,使用id或者主键作为条件
     * 
     * @param t
     *            待更新对象
     * @param fields
     *            字段列表
     * @return 是否更新成功
     */
    default boolean update(T t, String... fields) {
        return dao().update(t.getClass(), makeChain(t, fields), getCnd(t)) == 1;
    }

    default Chain makeChain(T t, String[] fields) {
        return Chain.from(t, FieldMatcher.simple(fields), dao());
    }

    default Condition getCnd(T t) {
        Mirror clazzMirror = Mirror.me(t);// 获取类型的镜像
        Field idField = null;
        try {
            idField = clazzMirror.getField(Id.class);
        }
        catch (NoSuchFieldException e) {
            try {
                idField = clazzMirror.getField(Name.class);
            }
            catch (NoSuchFieldException e1) {
                throw Lang.wrapThrow(e1);
            }
            String fieldName = idField.getName();
            Object value = clazzMirror.getValue(t, idField);
            return Cnd.where(fieldName, EQ, value);
        }
        String fieldName = idField.getName();
        Object value = clazzMirror.getValue(t, idField);
        return Cnd.where(fieldName, EQ, value);
    }

    /**
     * 根据条件更新数据
     * 
     * @param t
     *            更新目标数据样本
     * @param cnd
     *            条件
     * @param fields
     *            待更新的字段列表
     * @return 影响的记录条数
     */
    default int update(T t, Condition cnd, String... fields) {
        try {
            return dao().update(t.getClass(), Chain.from(t, FieldMatcher.simple(fields), dao()), cnd);
        }
        catch (Exception e) {
            Logs.get().error(e);
            return 0;
        }
    }

    /**
     * 根据条件更新数据
     * 
     * @param t
     *            更新目标数据样本
     * @param cnd
     *            条件
     * @return 影响的记录条数
     */
    default int update(T t, Condition cnd) {
        try {
            return dao().update(t.getClass(), Chain.from(t), cnd);
        }
        catch (Exception e) {
            Logs.get().error(e);
            return 0;
        }
    }

    /**
     * 清除全部数据
     *
     * @return 记录条数
     */
    default int clear() {
        return clear(null);
    }

    /**
     * 删除关联数据
     *
     * @param obj
     *            对象
     * @param regex
     *            正则
     * @return 是否删除成功
     */
    default T clearLinks(T obj, final String regex) {
        return dao().clearLinks(obj, regex);
    }

    /**
     * 删除对象
     * 
     * @param obj
     *            待删除对象
     * @return 影响的记录条数
     */
    default int delete(T obj) {
        return dao().delete(obj);
    }

    default int deleteWith(T obj, final String regex) {
        return dao().deleteWith(obj, regex);
    }

    default int deleteLinks(T obj, final String regex) {
        return dao().deleteLinks(obj, regex);
    }

    /**
     * 创建sql对象
     *
     * @param key
     *            sqlManager中的sql key
     * @return Sql 对象
     */
    default Sql createSql(String key) {
        return dao().sqls().create(Strings.trim(key));
    }

    /**
     * 创建sql对象
     *
     * @param key
     *            sqlManager中的sql key
     * @return Sql 对象
     */
    default Sql sql(String key) {
        return dao().sqls().create(Strings.trim(key));
    }

    /**
     * 获取entity
     * 
     * @param 
     *            类型
     * @param clazz
     *            entity字节码
     * @return entity实例
     */
    default  org.nutz.dao.entity.Entity entity(Class clazz) {
        return dao().getEntity(clazz);
    }

    /**
     * 执行sql
     * 
     * @param sql
     *            待执行sql
     * @return 执行后的sql对象
     */
    default Sql excute(Sql sql) {
        return dao().execute(sql);
    }

    /**
     * 最大值
     * 
     * @param field
     *            字段
     * @param condition
     *            条件
     * @return 满足条件的字段最大值
     */
    default int max(String field, Cnd condition) {
        return dao().func(getEntityType(), "max", field, condition);
    }

    /**
     * 最小值
     * 
     * @param field
     *            字段
     * @param condition
     *            条件
     * @return 满足条件的字段最小值
     */
    default int min(String field, Cnd condition) {
        return dao().func(getEntityType(), "min", field, condition);
    }

    /**
     * 平均值
     * 
     * @param field
     *            字段
     * @param condition
     *            条件
     * @return 满足条件的字段平均值
     */
    default int avg(String field, Cnd condition) {
        return dao().func(getEntityType(), "avg", field, condition);
    }

    /**
     * 求和
     * 
     * @param field
     *            字段
     * @param condition
     *            条件
     * @return 满足条件的字段求和值
     */
    default int sum(String field, Cnd condition) {
        return dao().func(getEntityType(), "sum", field, condition);
    }

    /**
     * 最大值
     * 
     * @param field
     *            字段
     * @return 字段最大值
     */
    default int max(String field) {
        return max(field, null);
    }

    /**
     * 最小值
     * 
     * @param field
     *            字段
     * @return 字段最小值
     */
    default int min(String field) {
        return min(field, null);
    }

    /**
     * 平均值
     * 
     * @param field
     *            字段
     * @return 字段平均值
     */
    default int avg(String field) {
        return avg(field, null);
    }

    /**
     * 求和
     * 
     * @param field
     *            字段
     * @return 字段求和值
     */
    default int sum(String field) {
        return sum(field, null);
    }

}




© 2015 - 2025 Weber Informatics LLC | Privacy Policy