Remove parameter name restriction when assigning keys generated by multi-row insert.

[harawata]

Currently, to assign keys generated by multi-row insert, the target parameter must have a special name (i.e. 'list', 'collection' or 'array').
Many users found this restriction unintuitive and inflexible (I agree).

This PR removes the restriction so that the target parameter can have any name.
It comes with two backward incompatible change, though.

1. When there are multiple parameters, keyProperty must include the parameter name.
2. When calling SqlSession methods directly, the target list, collection or array must be the only parameter.

See below for the details

1. When there are multiple parameters, keyProperty must include the parameter name.

Let's consider the following insert statement which takes two parameters.
Assuming that you want to assign generated keys to id property of each Country inserted.

int insert(
  @Param("list") List<Country> countries,
  @Param("someBean") SomeBean someBean);

In version ≤3.4.6, the correct value of keyProperty was id.

<insert id="insertListAndSomeId" useGeneratedKeys="true"
    keyProperty="id">
  insert into country (countryname,countrycode) values
  <foreach collection="list" separator="," item="country">
    (#{country.countryname},#{country.countrycode})
  </foreach>
</insert>

Once this PR gets merged, keyProperty must be specified as list.id.

<insert id="insertListAndSomeId" useGeneratedKeys="true"
    keyProperty="list.id">
...

2. When calling SqlSession methods directly, the target list, collection or array must be the only parameter.

With the following code, the generated keys were assigned to the 'list' parameter in version ≤3.4.6.
This PR does not support this usage.

List<Country> countries = ...;
SomeBean someBean = ...;

Map<String, Object> params = new HashMap<>();
params.put("list", countries);
params.put("someBean", someBean);

sqlSession.update("...", params);

[kazuki43zoo]

Could it support following code ?

List<Country> countries = ...;
SomeBean someBean = ...;

Map<String, Object> params = new HashMap<>();
params.put("list", countries);
params.put("someBean", someBean);

sqlSession.update("...", params);

In this case, is need to use the DefaultSqlSession$StrictMap as follows ?

List<Country> countries = ...;
SomeBean someBean = ...;

Map<String, Object> params = new StrictMap<Object>();
params.put("list", countries);
params.put("someBean", someBean);

sqlSession.update("...", params);

[harawata]

Thank you, @kazuki43zoo .
This PR does not support it (I intentionally dropped it, but forgot about it).
With this PR, when calling SqlSession methods directly (i.e. using XML mapper only), the target list, collection or array must be the only parameter.

Do you think that usage is important?
If so, I would take a different approach i.e. 1) introducing a new syntax list[].id for keyProperty (this was proposed in the original issue #324) or 2) introducing a new option keyCollection to specify the target list, collection or array.

@jeffgbutler , You reviewed the original PR. Any thoughts on the spec?

[kazuki43zoo]

Do you think that usage is important?

No. However, I prefer to announce dropping backward compatibility and introduce workaround in a release note(or migration guide).

[harawata]

Yes, it should be mentioned in the release note.
By workaround, you mean the code using StrictMap? I thought that was an internal class.
The workaround I had in mind was to use Java mapper. Could this be a big limitation?

[kazuki43zoo]

By workaround, you mean the code using StrictMap? I thought that was an internal class.
The workaround I had in mind was to use Java mapper.

I agree.

[lovepoem]

@harawata

Let's consider the following insert statement which takes two parameters.
Assuming that you want to assign generated keys to id property of each Country inserted.

int insert(
  @Param("list") List<Country> countries,
  @Param("someBean") SomeBean someBean);

If this pr is merged, can param name be named arbitrarily instead of the specified "list"?

[harawata]

Thanks for the comment, @lovepoem !

If this pr is merged, can param name be named arbitrarily instead of the specified "list"?

Yes. For example, you can name the parameter 'countries'.

int insert(
  @Param("countries") List<Country> countries,
  @Param("someBean") SomeBean someBean);

The keyProperty, in this case, needs to be 'countries.id'.

<insert id="insertListAndSomeId" useGeneratedKeys="true"
    keyProperty="countries.id">

[lovepoem]

If so , It look good to me

It's a good pr