|
| 1 | +package io.mybatis.mapper.logical; |
| 2 | + |
| 3 | +import io.mybatis.mapper.BaseMapper; |
| 4 | +import io.mybatis.mapper.example.Example; |
| 5 | +import io.mybatis.mapper.fn.Fn; |
| 6 | +import io.mybatis.mapper.fn.FnMapper; |
| 7 | +import io.mybatis.provider.Caching; |
| 8 | +import org.apache.ibatis.annotations.*; |
| 9 | +import org.apache.ibatis.cursor.Cursor; |
| 10 | +import org.apache.ibatis.session.RowBounds; |
| 11 | + |
| 12 | +import java.io.Serializable; |
| 13 | +import java.util.List; |
| 14 | +import java.util.Optional; |
| 15 | + |
| 16 | +/** |
| 17 | + * 逻辑删除的 Mapper 方法 |
| 18 | + * <p>继承此mapper会覆盖BaseMapper、FnMapper中的查、删、改相关方法</p> |
| 19 | + * |
| 20 | + * @author hzw |
| 21 | + */ |
| 22 | +public interface LogicalMapper<T, I extends Serializable> extends BaseMapper<T, I>, FnMapper<T> { |
| 23 | + /* BaseMapper +++ */ |
| 24 | + |
| 25 | + @Override |
| 26 | + @Lang(Caching.class) |
| 27 | + @UpdateProvider(type = LogicalProvider.class, method = "updateByPrimaryKeySelectiveWithForceFields") |
| 28 | + int updateByPrimaryKeySelectiveWithForceFields(@Param("entity") T entity, @Param("fns") Fn.Fns<T> forceUpdateFields); |
| 29 | + |
| 30 | + /* BaseMapper --- */ |
| 31 | + |
| 32 | + /* FnMapper +++ */ |
| 33 | + |
| 34 | + @Override |
| 35 | + @Lang(Caching.class) |
| 36 | + @SelectProvider(type = LogicalProvider.class, method = "selectColumns") |
| 37 | + Optional<T> selectColumnsOne(@Param("entity") T entity, @Param("fns") Fn.Fns<T> selectFields); |
| 38 | + |
| 39 | + @Override |
| 40 | + @Lang(Caching.class) |
| 41 | + @SelectProvider(type = LogicalProvider.class, method = "selectColumns") |
| 42 | + List<T> selectColumns(@Param("entity") T entity, @Param("fns") Fn.Fns<T> selectFields); |
| 43 | + |
| 44 | + /* FnMapper --- */ |
| 45 | + |
| 46 | + /* EntityMapper +++ */ |
| 47 | + |
| 48 | + @Override |
| 49 | + @Lang(Caching.class) |
| 50 | + @DeleteProvider(type = LogicalProvider.class, method = "deleteByPrimaryKey") |
| 51 | + int deleteByPrimaryKey(I id); |
| 52 | + |
| 53 | + @Override |
| 54 | + @Lang(Caching.class) |
| 55 | + @DeleteProvider(type = LogicalProvider.class, method = "delete") |
| 56 | + int delete(T entity); |
| 57 | + |
| 58 | + @Override |
| 59 | + @Lang(Caching.class) |
| 60 | + @UpdateProvider(type = LogicalProvider.class, method = "updateByPrimaryKey") |
| 61 | + int updateByPrimaryKey(T entity); |
| 62 | + |
| 63 | + @Override |
| 64 | + @Lang(Caching.class) |
| 65 | + @UpdateProvider(type = LogicalProvider.class, method = "updateByPrimaryKeySelective") |
| 66 | + int updateByPrimaryKeySelective(T entity); |
| 67 | + |
| 68 | + @Override |
| 69 | + @Lang(Caching.class) |
| 70 | + @SelectProvider(type = LogicalProvider.class, method = "selectByPrimaryKey") |
| 71 | + Optional<T> selectByPrimaryKey(I id); |
| 72 | + |
| 73 | + @Override |
| 74 | + @Lang(Caching.class) |
| 75 | + @SelectProvider(type = LogicalProvider.class, method = "select") |
| 76 | + Optional<T> selectOne(T entity); |
| 77 | + |
| 78 | + @Override |
| 79 | + @Lang(Caching.class) |
| 80 | + @SelectProvider(type = LogicalProvider.class, method = "select") |
| 81 | + List<T> selectList(T entity); |
| 82 | + |
| 83 | + @Override |
| 84 | + @Lang(Caching.class) |
| 85 | + @SelectProvider(type = LogicalProvider.class, method = "selectCount") |
| 86 | + long selectCount(T entity); |
| 87 | + |
| 88 | + /* EntityMapper --- */ |
| 89 | + |
| 90 | + /* CursorMapper +++ */ |
| 91 | + |
| 92 | + @Override |
| 93 | + @Lang(Caching.class) |
| 94 | + @SelectProvider(type = LogicalProvider.class, method = "select") |
| 95 | + Cursor<T> selectCursor(T entity); |
| 96 | + |
| 97 | + @Override |
| 98 | + @Lang(Caching.class) |
| 99 | + @SelectProvider(type = LogicalProvider.class, method = "selectByExample") |
| 100 | + Cursor<T> selectCursorByExample(Example<T> example); |
| 101 | + |
| 102 | + /* CursorMapper --- */ |
| 103 | + |
| 104 | + /* ExampleMapper +++ */ |
| 105 | + @Override |
| 106 | + default Example<T> example() { |
| 107 | + return BaseMapper.super.example(); |
| 108 | + } |
| 109 | + |
| 110 | + @Override |
| 111 | + @Lang(Caching.class) |
| 112 | + @DeleteProvider(type = LogicalProvider.class, method = "deleteByExample") |
| 113 | + int deleteByExample(Example<T> example); |
| 114 | + |
| 115 | + @Override |
| 116 | + @Lang(Caching.class) |
| 117 | + @UpdateProvider(type = LogicalProvider.class, method = "updateByExample") |
| 118 | + int updateByExample(@Param("entity") T entity, @Param("example") Example<T> example); |
| 119 | + |
| 120 | + @Override |
| 121 | + @Lang(Caching.class) |
| 122 | + @UpdateProvider(type = LogicalProvider.class, method = "updateByExampleSetValues") |
| 123 | + int updateByExampleSetValues(@Param("example") Example<T> example); |
| 124 | + |
| 125 | + @Override |
| 126 | + @Lang(Caching.class) |
| 127 | + @UpdateProvider(type = LogicalProvider.class, method = "updateByExampleSelective") |
| 128 | + int updateByExampleSelective(@Param("entity") T entity, @Param("example") Example<T> example); |
| 129 | + |
| 130 | + @Override |
| 131 | + @Lang(Caching.class) |
| 132 | + @SelectProvider(type = LogicalProvider.class, method = "selectByExample") |
| 133 | + List<T> selectByExample(Example<T> example); |
| 134 | + |
| 135 | + @Override |
| 136 | + @Lang(Caching.class) |
| 137 | + @SelectProvider(type = LogicalProvider.class, method = "selectByExample") |
| 138 | + Optional<T> selectOneByExample(Example<T> example); |
| 139 | + |
| 140 | + @Override |
| 141 | + @Lang(Caching.class) |
| 142 | + @SelectProvider(type = LogicalProvider.class, method = "countByExample") |
| 143 | + long countByExample(Example<T> example); |
| 144 | + |
| 145 | + @Override |
| 146 | + List<T> selectByExample(Example<T> example, RowBounds rowBounds); |
| 147 | + |
| 148 | + /* ExampleMapper --- */ |
| 149 | +} |
0 commit comments