Mybatis中的@Select、foreach用法

Posted on by

Mybatis @Select、foreach

foreach屬性

屬性 描述
item 循環體中的具體對象。支持屬性的點路徑訪問，如item.age,item.info.details。 具體說明：在list和數組中是其中的對象，在map中是value。 該參數為必選。
collection 要做foreach的對象，作為入參時，List<?>對象默認用list代替作為鍵，數組對象用array代替作為鍵，Map對象用map代替作為鍵。 當然在作為入參時可以使用@Param(“keyName”)來設置鍵，設置keyName後，list,array,map將會失效。 除瞭入參這種情況外，還有一種作為參數對象的某個字段的時候。舉個例子： 如果User有屬性List ids。入參是User對象，那麼這個collection = “ids” 如果User有屬性Ids ids;其中Ids是個對象，Ids有個屬性List id;入參是User對象，那麼collection = “ids.id” 上面隻是舉例，具體collection等於什麼，就看你想對那個元素做循環。 該參數為必選。
separator 元素之間的分隔符，例如在in()的時候，separator=","會自動在元素中間用“,“隔開，避免手動輸入逗號導致sql錯誤，如in(1,2,)這樣。該參數可選。
open foreach代碼的開始符號，一般是(和close=")"合用。常用在in(),values()時。該參數可選。
close foreach代碼的關閉符號，一般是)和open="("合用。常用在in(),values()時。該參數可選。
index 在list和數組中,index是元素的序號，在map中，index是元素的key，該參數可選。

Mapper層

List<UserRole> selectIdList(List<Long> userList);

XML語句

<select id="selectIdList" parameterType="java.util.List" resultType="com.yuantu.dev.sys.entity.UserRole">
        SELECT id,user_id,role_id FROM sys_user_role
        WHERE user_id IN
        <foreach collection="list" index="index" item="item" open="(" separator="," close=")">
            #{item}
        </foreach>
</select>

@Select註解

常用查詢

@Select("select * from web_admins where id = #{id}")
Admin selectAdminById(@Param("id") Integer id);

在@Select中拼寫動態SQL語句

對於條件較復雜的情況，不太建議這種方式，在字符串中難免會有很多錯誤，可讀性很差。

@Select("<script>" +
        "SELECT * FROM users WHERE id in \n" +
        "<foreach collection='usedUserIdList' index='index' item='item' open='(' separator=',' close=')'>#{item}</foreach> \n" +
        "AND open_card_order_state = 1" +
        "</script>")
List<Users> selectUsers(@Param("usedUserIdList") List<Integer> usedUserIdList,Page<Users> page);

Mybatis foreach3種用法

用mybatis實現select 字段 from table where id in(1,2,3,4,5)的sql語句:

mybatis提供的foreach可以實現，foreach有3種傳值方式：array，list,map.

其中Array的mapper寫法

<select id="selectUserArr" resultMap="BaseResultMap">
    SELECT
    <include refid="Base_Column_List" />
    from user
    where id in
    <foreach collection="array" item="id" open="(" separator="," close=")">
        #{id}
    </foreach>
</select>

註：array的寫法中collection中的值必須是array,不能寫Array，會報錯的。但傳參的命名可以不是array

List<User>selectUserArr(int []arr);
List<User>userArray=userMapper.selectUserArr(arr);

list的寫法

<select id="selectUserList" resultMap="BaseResultMap">
    SELECT
    <include refid="Base_Column_List" />
    from user
    where id in
    <foreach collection="list" item="id" open="(" separator="," close=")">
        #{id}
    </foreach>
</select>

註：list寫法中collection中的值必須是list,也不能是List,但傳來的參數命名可以不一定是list

List<User>selectUserList(List list1);
List<User>userList=userMapper.selectUserList(list1);

map的寫法

<select id="selectUserMap" resultMap="BaseResultMap">
    SELECT
    <include refid="Base_Column_List" />
    from user
    where id in
    <foreach collection="map1" item="id" open="(" separator="," close=")">
        #{id}
    </foreach>
</select>

註：map寫法中的collection中填的是map的key值，不對應就會報錯

List<User>selectUserMap(Map map);
map.put("map1",map1);
List<User> userMap=userMapper.selectUserMap(map);

在springboot的啟動類測試：

@SpringBootApplication
@MapperScan("springboot.mapper")
public class Application
{
    public static void main( String[] args )
    {
        ApplicationContext context  = SpringApplication.run(Application.class, args);
       
        UserMapper userMapper=context.getBean(UserMapper.class);

        int []arr=new int[5];
        List list1=new ArrayList();
        Map<String,Object> map=new HashMap<String, Object>(5);
        int i;
        for(i=1;i<5;i++){
            arr[i-1]=i;
            list1.add(i);

        }
        int []map1={1,2,3,4,5};
        map.put("map1",map1);
        List<User>userArray=userMapper.selectUserArr(arr);
        List<User>userList=userMapper.selectUserList(list1);
        List<User> userMap=userMapper.selectUserMap(map);

        System.out.println("Array=============");
        sys(userArray);
        System.out.println("list=============");
        sys(userList);
        System.out.println("map:================");
        sys(userMap);

    public static void sys(List<User> list){
        for (User user : list){
            System.out.println("user:"+user.toString());
        }
    }
}

效果如下：

    Array=============
        user:User{id=1, uname='小黑', upwd='123', unum='123', sex=0, age=18, addr='廣東', tid=1}
        user:User{id=2, uname='小白', upwd='234', unum='234', sex=1, age=21, addr='廣州', tid=1}
        user:User{id=3, uname='小紅', upwd='345', unum='345', sex=0, age=15, addr='天河區', tid=2}
        user:User{id=4, uname='小小', upwd='123', unum='567', sex=1, age=21, addr='null', tid=3}
        list=============
        user:User{id=1, uname='小黑', upwd='123', unum='123', sex=0, age=18, addr='廣東', tid=1}
        user:User{id=2, uname='小白', upwd='234', unum='234', sex=1, age=21, addr='廣州', tid=1}
        user:User{id=3, uname='小紅', upwd='345', unum='345', sex=0, age=15, addr='天河區', tid=2}
        user:User{id=4, uname='小小', upwd='123', unum='567', sex=1, age=21, addr='null', tid=3}
        map:================
        user:User{id=1, uname='小黑', upwd='123', unum='123', sex=0, age=18, addr='廣東', tid=1}
        user:User{id=2, uname='小白', upwd='234', unum='234', sex=1, age=21, addr='廣州', tid=1}
        user:User{id=3, uname='小紅', upwd='345', unum='345', sex=0, age=15, addr='天河區', tid=2}
        user:User{id=4, uname='小小', upwd='123', unum='567', sex=1, age=21, addr='null', tid=3}
        user:User{id=5, uname='柘城', upwd='123', unum='423', sex=0, age=23, addr='null', tid=2}

以上為個人經驗，希望能給大傢一個參考，也希望大傢多多支持WalkonNet。

推薦閱讀：