MapperMethodParamTest.java

/*
 *    Copyright 2009-2025 the original author or authors.
 *
 *    Licensed under the Apache License, Version 2.0 (the "License");
 *    you may not use this file except in compliance with the License.
 *    You may obtain a copy of the License at
 *
 *       https://www.apache.org/licenses/LICENSE-2.0
 *
 *    Unless required by applicable law or agreed to in writing, software
 *    distributed under the License is distributed on an "AS IS" BASIS,
 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *    See the License for the specific language governing permissions and
 *    limitations under the License.
 */
package org.apache.ibatis.binding;

import static org.assertj.core.api.Assertions.assertThat;

import java.util.HashMap;

import javax.sql.DataSource;

import org.apache.ibatis.BaseDataTest;
import org.apache.ibatis.annotations.Insert;
import org.apache.ibatis.annotations.Param;
import org.apache.ibatis.annotations.Select;
import org.apache.ibatis.mapping.Environment;
import org.apache.ibatis.session.Configuration;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;
import org.apache.ibatis.transaction.TransactionFactory;
import org.apache.ibatis.transaction.jdbc.JdbcTransactionFactory;
import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.Test;

class MapperMethodParamTest {

  private static SqlSessionFactory sqlSessionFactory;

  @BeforeAll
  static void setup() throws Exception {
    DataSource dataSource = BaseDataTest.createUnpooledDataSource(BaseDataTest.BLOG_PROPERTIES);
    BaseDataTest.runScript(dataSource, "org/apache/ibatis/binding/paramtest-schema.sql");
    TransactionFactory transactionFactory = new JdbcTransactionFactory();
    Environment environment = new Environment("Production", transactionFactory, dataSource);
    Configuration configuration = new Configuration(environment);
    configuration.addMapper(Mapper.class);
    sqlSessionFactory = new SqlSessionFactoryBuilder().build(configuration);
  }

  @Test
  void parameterNameIsSizeAndTypeIsLong() {
    try (SqlSession session = sqlSessionFactory.openSession()) {
      Mapper mapper = session.getMapper(Mapper.class);
      mapper.insert("foo", Long.MAX_VALUE);
      assertThat(mapper.selectSize("foo")).isEqualTo(Long.MAX_VALUE);
    }
  }

  @Test
  void parameterNameIsSizeUsingHashMap() {
    try (SqlSession session = sqlSessionFactory.openSession()) {
      HashMap<String, Object> params = new HashMap<>();
      params.put("id", "foo");
      params.put("size", Long.MAX_VALUE);
      Mapper mapper = session.getMapper(Mapper.class);
      mapper.insertUsingHashMap(params);
      assertThat(mapper.selectSize("foo")).isEqualTo(Long.MAX_VALUE);
    }
  }

  interface Mapper {
    @Insert("insert into param_test (id, size) values(#{id}, #{size})")
    void insert(@Param("id") String id, @Param("size") long size);

    @Insert("insert into param_test (id, size) values(#{id}, #{size})")
    void insertUsingHashMap(HashMap<String, Object> params);

    @Select("select size from param_test where id = #{id}")
    long selectSize(@Param("id") String id);
  }

}