#1227

Committed 14 Sep 2023 05:15PM CUT coverage: 89.622%. Remained the same

Build # #1227

Build Type

Pull #854

github

Committed by

web-flow

Commit Message

Update dependency net.bytebuddy:byte-buddy-agent to v1.14.8

Pull Request Pull Request #854: Update dependency net.bytebuddy:byte-buddy-agent to v1.14.8

Run Details

829 of 925 relevant lines covered (89.62%)

0.9 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

88.0

/src/main/java/org/mybatis/spring/mapper/MapperFactoryBean.java

/*
 * Copyright 2010-2022 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.mybatis.spring.mapper;

import static org.springframework.util.Assert.notNull;

import org.apache.ibatis.executor.ErrorContext;
import org.apache.ibatis.session.Configuration;
import org.mybatis.spring.SqlSessionTemplate;
import org.mybatis.spring.support.SqlSessionDaoSupport;
import org.springframework.beans.factory.FactoryBean;

/**
 * BeanFactory that enables injection of MyBatis mapper interfaces. It can be set up with a SqlSessionFactory or a
 * pre-configured SqlSessionTemplate.
 * <p>
 * Sample configuration:
 *
 * <pre class="code">
 * {@code
 *   <bean id="baseMapper" class="org.mybatis.spring.mapper.MapperFactoryBean" abstract="true" lazy-init="true">
 *     <property name="sqlSessionFactory" ref="sqlSessionFactory" />
 *   </bean>
 *
 *   <bean id="oneMapper" parent="baseMapper">
 *     <property name="mapperInterface" value="my.package.MyMapperInterface" />
 *   </bean>
 *
 *   <bean id="anotherMapper" parent="baseMapper">
 *     <property name="mapperInterface" value="my.package.MyAnotherMapperInterface" />
 *   </bean>
 * }
 * </pre>
 * <p>
 * Note that this factory can only inject <em>interfaces</em>, not concrete classes.
 *
 * @author Eduardo Macarron
 *
 * @see SqlSessionTemplate
 */
public class MapperFactoryBean<T> extends SqlSessionDaoSupport implements FactoryBean<T> {

  private Class<T> mapperInterface;

  private boolean addToConfig = true;

  public MapperFactoryBean() {
    // intentionally empty
  }

  public MapperFactoryBean(Class<T> mapperInterface) {
    this.mapperInterface = mapperInterface;
  }

  /**
   * {@inheritDoc}
   */
  @Override
  protected void checkDaoConfig() {
    super.checkDaoConfig();

    notNull(this.mapperInterface, "Property 'mapperInterface' is required");

    Configuration configuration = getSqlSession().getConfiguration();
    if (this.addToConfig && !configuration.hasMapper(this.mapperInterface)) {
      try {
        configuration.addMapper(this.mapperInterface);
      } catch (Exception e) {
        logger.error("Error while adding the mapper '" + this.mapperInterface + "' to configuration.", e);
        throw new IllegalArgumentException(e);
      } finally {
        ErrorContext.instance().reset();
      }
    }
  }

  /**
   * {@inheritDoc}
   */
  @Override
  public T getObject() throws Exception {
    return getSqlSession().getMapper(this.mapperInterface);
  }

  /**
   * {@inheritDoc}
   */
  @Override
  public Class<T> getObjectType() {
    return this.mapperInterface;
  }

  /**
   * {@inheritDoc}
   */
  @Override
  public boolean isSingleton() {
    return true;
  }

  // ------------- mutators --------------

  /**
   * Sets the mapper interface of the MyBatis mapper
   *
   * @param mapperInterface
   *          class of the interface
   */
  public void setMapperInterface(Class<T> mapperInterface) {
    this.mapperInterface = mapperInterface;
  }

  /**
   * Return the mapper interface of the MyBatis mapper
   *
   * @return class of the interface
   */
  public Class<T> getMapperInterface() {
    return mapperInterface;
  }

  /**
   * If addToConfig is false the mapper will not be added to MyBatis. This means it must have been included in
   * mybatis-config.xml.
   * <p>
   * If it is true, the mapper will be added to MyBatis in the case it is not already registered.
   * <p>
   * By default addToConfig is true.
   *
   * @param addToConfig
   *          a flag that whether add mapper to MyBatis or not
   */
  public void setAddToConfig(boolean addToConfig) {
    this.addToConfig = addToConfig;
  }

  /**
   * Return the flag for addition into MyBatis config.
   *
   * @return true if the mapper will be added to MyBatis in the case it is not already registered.
   */
  public boolean isAddToConfig() {
    return addToConfig;
  }
}

1	/*
2	* Copyright 2010-2022 the original author or authors.
3	*
4	* Licensed under the Apache License, Version 2.0 (the "License");
5	* you may not use this file except in compliance with the License.
6	* You may obtain a copy of the License at
7	*
8	* https://www.apache.org/licenses/LICENSE-2.0
9	*
10	* Unless required by applicable law or agreed to in writing, software
11	* distributed under the License is distributed on an "AS IS" BASIS,
12	* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13	* See the License for the specific language governing permissions and
14	* limitations under the License.
15	*/
16	package org.mybatis.spring.mapper;
17
18	import static org.springframework.util.Assert.notNull;
19
20	import org.apache.ibatis.executor.ErrorContext;
21	import org.apache.ibatis.session.Configuration;
22	import org.mybatis.spring.SqlSessionTemplate;
23	import org.mybatis.spring.support.SqlSessionDaoSupport;
24	import org.springframework.beans.factory.FactoryBean;
25
26	/**
27	* BeanFactory that enables injection of MyBatis mapper interfaces. It can be set up with a SqlSessionFactory or a
28	* pre-configured SqlSessionTemplate.
29	* <p>
30	* Sample configuration:
31	*
32	* <pre class="code">
33	* {@code
34	* <bean id="baseMapper" class="org.mybatis.spring.mapper.MapperFactoryBean" abstract="true" lazy-init="true">
35	* <property name="sqlSessionFactory" ref="sqlSessionFactory" />
36	* </bean>
37	*
38	* <bean id="oneMapper" parent="baseMapper">
39	* <property name="mapperInterface" value="my.package.MyMapperInterface" />
40	* </bean>
41	*
42	* <bean id="anotherMapper" parent="baseMapper">
43	* <property name="mapperInterface" value="my.package.MyAnotherMapperInterface" />
44	* </bean>
45	* }
46	* </pre>
47	* <p>
48	* Note that this factory can only inject <em>interfaces</em>, not concrete classes.
49	*
50	* @author Eduardo Macarron
51	*
52	* @see SqlSessionTemplate
53	*/
54	public class MapperFactoryBean<T> extends SqlSessionDaoSupport implements FactoryBean<T> {
55
56	private Class<T> mapperInterface;
57
58	private boolean addToConfig = true;	1✔
59
60	public MapperFactoryBean() {	1✔
61	// intentionally empty
62	}	1✔
63
64	public MapperFactoryBean(Class<T> mapperInterface) {	1✔
65	this.mapperInterface = mapperInterface;	1✔
66	}	1✔
67
68	/**
69	* {@inheritDoc}
70	*/
71	@Override
72	protected void checkDaoConfig() {
73	super.checkDaoConfig();	1✔
74
75	notNull(this.mapperInterface, "Property 'mapperInterface' is required");	1✔
76
77	Configuration configuration = getSqlSession().getConfiguration();	1✔
78	if (this.addToConfig && !configuration.hasMapper(this.mapperInterface)) {	1✔
79	try {
80	configuration.addMapper(this.mapperInterface);	1✔
81	} catch (Exception e) {	×
82	logger.error("Error while adding the mapper '" + this.mapperInterface + "' to configuration.", e);	×
83	throw new IllegalArgumentException(e);	×
84	} finally {
85	ErrorContext.instance().reset();	1✔
86	}
87	}
88	}	1✔
89
90	/**
91	* {@inheritDoc}
92	*/
93	@Override
94	public T getObject() throws Exception {
95	return getSqlSession().getMapper(this.mapperInterface);	1✔
96	}
97
98	/**
99	* {@inheritDoc}
100	*/
101	@Override
102	public Class<T> getObjectType() {
103	return this.mapperInterface;	1✔
104	}
105
106	/**
107	* {@inheritDoc}
108	*/
109	@Override
110	public boolean isSingleton() {
111	return true;	1✔
112	}
113
114	// ------------- mutators --------------
115
116	/**
117	* Sets the mapper interface of the MyBatis mapper
118	*
119	* @param mapperInterface
120	* class of the interface
121	*/
122	public void setMapperInterface(Class<T> mapperInterface) {
123	this.mapperInterface = mapperInterface;	1✔
124	}	1✔
125
126	/**
127	* Return the mapper interface of the MyBatis mapper
128	*
129	* @return class of the interface
130	*/
131	public Class<T> getMapperInterface() {
132	return mapperInterface;	1✔
133	}
134
135	/**
136	* If addToConfig is false the mapper will not be added to MyBatis. This means it must have been included in
137	* mybatis-config.xml.
138	* <p>
139	* If it is true, the mapper will be added to MyBatis in the case it is not already registered.
140	* <p>
141	* By default addToConfig is true.
142	*
143	* @param addToConfig
144	* a flag that whether add mapper to MyBatis or not
145	*/
146	public void setAddToConfig(boolean addToConfig) {
147	this.addToConfig = addToConfig;	1✔
148	}	1✔
149
150	/**
151	* Return the flag for addition into MyBatis config.
152	*
153	* @return true if the mapper will be added to MyBatis in the case it is not already registered.
154	*/
155	public boolean isAddToConfig() {
156	return addToConfig;	1✔
157	}
158	}

mybatis / spring / #1227

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous