在 SpringMVC 中扩展MyBatis 的 SqlSessionFactoryBean使其支持 Apache Ant 路径匹配的TypeAliases 配置方式-Lastme

软件包环境:

mybatis-spring-1.2.3.jar
mybatis-3.3.0.jar
spring webmvc 4.1.6

MyBatis 的别名配置文件入口只有能有一个，而且必须写在这个文件或者添加包的扫描路径然后使用注解，很难维护，要想web项目模块间的依赖，维护更是十分困难。所以重写了SqlSessionFactoryBean.

中间的很多代码是直接复制MyBatis 的 SqlSessionFactoryBean类的源码,然后添加自己的扩展代码,整合MyBatis和SpringMVC的时候,配置文件中只需要这样配置就可以了,

<bean id="sqlSessionFactory" class="com.kernelstudio.vendor.component.mybatis.SqlSessionFactoryBean">
    <property name="dataSource" ref="dataSource" />
    <!-- Mapper映射配置 -->
    <property name="mapperLocations" value="classpath*:com/kernelstudio/app/bundle/*/resource/mybatis/mapper/*.xml" />
    <!-- 别名配置扫描路径 -->
    <property name="antTypeAliasesLocations" value="classpath*:com/kernelstudio/app/bundle/*/resource/mybatis/*aliases.xml" />
</bean>

下面的截图是我项目中的代码目录结构,bundle下面的都是按模块划分,

直接上代码:

package com.kernelstudio.vendor.component.mybatis;

/**
 * 
 * This file is part of the KernelStudio package.
 * 
 * (c) 2015 kernelstudio <developer@kernelstudio.com>
 * 
 * For the full copyright and license information, please view the LICENSE file
 * that was distributed with this source code.
 * 
 * @author zhoulin < developer@kernelstudio.com >
 * @link http://www.kernelstudio.com
 * @version 0.1
 * @since 0.1
 */
import static org.springframework.util.Assert.notNull;
import static org.springframework.util.ObjectUtils.isEmpty;
import static org.springframework.util.StringUtils.hasLength;
import static org.springframework.util.StringUtils.tokenizeToStringArray;

import java.io.IOException;
import java.sql.SQLException;
import java.util.HashMap;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Properties;

import javax.sql.DataSource;

import org.apache.ibatis.builder.xml.XMLConfigBuilder;
import org.apache.ibatis.builder.xml.XMLMapperBuilder;
import org.apache.ibatis.executor.ErrorContext;
import org.apache.ibatis.logging.Log;
import org.apache.ibatis.logging.LogFactory;
import org.apache.ibatis.mapping.DatabaseIdProvider;
import org.apache.ibatis.mapping.Environment;
import org.apache.ibatis.plugin.Interceptor;
import org.apache.ibatis.reflection.factory.ObjectFactory;
import org.apache.ibatis.reflection.wrapper.ObjectWrapperFactory;
import org.apache.ibatis.session.Configuration;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;
import org.apache.ibatis.transaction.TransactionFactory;
import org.apache.ibatis.type.TypeAliasRegistry;
import org.apache.ibatis.type.TypeHandler;
import org.mybatis.spring.transaction.SpringManagedTransactionFactory;
import org.springframework.beans.factory.FactoryBean;
import org.springframework.beans.factory.InitializingBean;
import org.springframework.context.ApplicationEvent;
import org.springframework.context.ApplicationListener;
import org.springframework.context.ConfigurableApplicationContext;
import org.springframework.context.event.ContextRefreshedEvent;
import org.springframework.core.NestedIOException;
import org.springframework.core.io.Resource;
import org.springframework.core.io.support.PathMatchingResourcePatternResolver;
import org.springframework.core.io.support.ResourcePatternResolver;
import org.springframework.jdbc.datasource.TransactionAwareDataSourceProxy;

/**
 * {@code FactoryBean} that creates an MyBatis {@code SqlSessionFactory}. This
 * is the usual way to set up a shared MyBatis {@code SqlSessionFactory} in a
 * Spring application context; the SqlSessionFactory can then be passed to
 * MyBatis-based DAOs via dependency injection.
 * 
 * Either {@code DataSourceTransactionManager} or {@code JtaTransactionManager}
 * can be used for transaction demarcation in combination with a
 * {@code SqlSessionFactory}. JTA should be used for transactions which span
 * multiple databases or when container managed transactions (CMT) are being
 * used.
 * 
 * @author Putthibong Boonbong
 * @author Hunter Presnall
 * @author Eduardo Macarron
 * 
 * @see #setConfigLocation
 * @see #setDataSource
 * @version $Id$
 */
public class SqlSessionFactoryBean implements FactoryBean<SqlSessionFactory>, InitializingBean, ApplicationListener<ApplicationEvent>
{

    private static final Log LOGGER = LogFactory.getLog(SqlSessionFactoryBean.class);
    private Resource configLocation;
    private Resource[] mapperLocations;
    private DataSource dataSource;
    private TransactionFactory transactionFactory;
    private Properties configurationProperties;
    private SqlSessionFactoryBuilder sqlSessionFactoryBuilder = new SqlSessionFactoryBuilder();
    private SqlSessionFactory sqlSessionFactory;
    // EnvironmentAware requires spring 3.1
    private String environment = SqlSessionFactoryBean.class.getSimpleName();
    private boolean failFast;
    private Interceptor[] plugins;
    private TypeHandler<?>[] typeHandlers;
    private String typeHandlersPackage;
    private Class<?>[] typeAliases;
    private String typeAliasesPackage;
    private Class<?> typeAliasesSuperType;
    // issue #19. No default provider.
    private DatabaseIdProvider databaseIdProvider;
    private ObjectFactory objectFactory;
    private ObjectWrapperFactory objectWrapperFactory;
    private String antTypeAliasesLocations;
    private Map<String, Class<?>> antTypeAliasesMap;
    
    /**
     * Build a {@code SqlSessionFactory} instance.
     * 
     * The default implementation uses the standard MyBatis
     * {@code XMLConfigBuilder} API to build a {@code SqlSessionFactory}
     * instance based on an Reader.
     * 
     * @return SqlSessionFactory
     * @throws IOException if loading the config file failed
     */
    protected SqlSessionFactory buildSqlSessionFactory() throws IOException
    {
    
        Configuration configuration;
    
        XMLConfigBuilder xmlConfigBuilder = null;
        if (this.configLocation != null) {
            xmlConfigBuilder = new XMLConfigBuilder(this.configLocation.getInputStream(), null, this.configurationProperties);
            configuration = xmlConfigBuilder.getConfiguration();
        } else {
            if (LOGGER.isDebugEnabled()) {
                LOGGER.debug("Property 'configLocation' not specified, using default MyBatis Configuration");
            }
            configuration = new Configuration();
            configuration.setVariables(this.configurationProperties);
        }
    
        if (this.objectFactory != null) {
            configuration.setObjectFactory(this.objectFactory);
        }
    
        if (this.objectWrapperFactory != null) {
            configuration.setObjectWrapperFactory(this.objectWrapperFactory);
        }
    
        if (hasLength(this.typeAliasesPackage)) {
            String[] typeAliasPackageArray = tokenizeToStringArray(this.typeAliasesPackage, ConfigurableApplicationContext.CONFIG_LOCATION_DELIMITERS);
            for (String packageToScan : typeAliasPackageArray) {
                configuration.getTypeAliasRegistry().registerAliases(packageToScan, typeAliasesSuperType == null ? Object.class : typeAliasesSuperType);
                if (LOGGER.isDebugEnabled()) {
                    LOGGER.debug("Scanned package: '" + packageToScan + "' for aliases");
                }
            }
        }
    
        // 扩展ant风格的别名配置
        buildAntTypeAliasesPackage(configuration);
        if (null != this.antTypeAliasesMap && !this.antTypeAliasesMap.isEmpty()) {
            for (Entry<String, Class<?>> typeAlias : this.antTypeAliasesMap.entrySet()) {
                configuration.getTypeAliasRegistry().registerAlias(typeAlias.getKey(), typeAlias.getValue());
                if (LOGGER.isDebugEnabled()) {
                    LOGGER.debug("Registered ant type alias: '" + typeAlias.getKey() + "[" + typeAlias.getValue().getName() + "]" + "'");
                }
            }
        }
        // end
    
        if (!isEmpty(this.typeAliases)) {
            for (Class<?> typeAlias : this.typeAliases) {
                configuration.getTypeAliasRegistry().registerAlias(typeAlias);
                if (LOGGER.isDebugEnabled()) {
                    LOGGER.debug("Registered type alias: '" + typeAlias + "'");
                }
            }
        }
    
        if (!isEmpty(this.plugins)) {
            for (Interceptor plugin : this.plugins) {
                configuration.addInterceptor(plugin);
                if (LOGGER.isDebugEnabled()) {
                    LOGGER.debug("Registered plugin: '" + plugin + "'");
                }
            }
        }
    
        if (hasLength(this.typeHandlersPackage)) {
            String[] typeHandlersPackageArray = tokenizeToStringArray(this.typeHandlersPackage, ConfigurableApplicationContext.CONFIG_LOCATION_DELIMITERS);
            for (String packageToScan : typeHandlersPackageArray) {
                configuration.getTypeHandlerRegistry().register(packageToScan);
                if (LOGGER.isDebugEnabled()) {
                    LOGGER.debug("Scanned package: '" + packageToScan + "' for type handlers");
                }
            }
        }
    
        if (!isEmpty(this.typeHandlers)) {
            for (TypeHandler<?> typeHandler : this.typeHandlers) {
                configuration.getTypeHandlerRegistry().register(typeHandler);
                if (LOGGER.isDebugEnabled()) {
                    LOGGER.debug("Registered type handler: '" + typeHandler + "'");
                }
            }
        }
    
        // fix #64 set databaseId before
        if (this.databaseIdProvider != null) {
            // parse mapper xmls
            try {
                configuration.setDatabaseId(this.databaseIdProvider.getDatabaseId(this.dataSource));
            } catch (SQLException e) {
                throw new NestedIOException("Failed getting a databaseId", e);
            }
        }
    
        if (xmlConfigBuilder != null) {
            try {
                xmlConfigBuilder.parse();
    
                if (LOGGER.isDebugEnabled()) {
                    LOGGER.debug("Parsed configuration file: '" + this.configLocation + "'");
                }
            } catch (Exception ex) {
                throw new NestedIOException("Failed to parse config resource: " + this.configLocation, ex);
            } finally {
                ErrorContext.instance().reset();
            }
        }
    
        if (this.transactionFactory == null) {
            this.transactionFactory = new SpringManagedTransactionFactory();
        }
    
        configuration.setEnvironment(new Environment(this.environment, this.transactionFactory, this.dataSource));
    
        if (!isEmpty(this.mapperLocations)) {
    
            for (Resource mapperLocation : this.mapperLocations) {
                if (mapperLocation == null) {
                    continue;
                }
    
                try {
                    XMLMapperBuilder xmlMapperBuilder = new XMLMapperBuilder(mapperLocation.getInputStream(), configuration, mapperLocation.toString(),
                            configuration.getSqlFragments());
                    xmlMapperBuilder.parse();
                } catch (Exception e) {
                    throw new NestedIOException("Failed to parse mapping resource: '" + mapperLocation + "'", e);
                } finally {
                    ErrorContext.instance().reset();
                }
    
                if (LOGGER.isDebugEnabled()) {
                    LOGGER.debug("Parsed mapper file: '" + mapperLocation + "'");
                }
            }
        } else {
            if (LOGGER.isDebugEnabled()) {
                LOGGER.debug("Property 'mapperLocations' was not specified or no matching resources found");
            }
        }
    
        return this.sqlSessionFactoryBuilder.build(configuration);
    }
    
    /**
     * 
     * @param configuration
     * @throws IOException
     */
    private Map<String, Class<?>> buildAntTypeAliasesPackage(Configuration configuration) throws IOException
    {
        if (antTypeAliasesLocations != null) {
            Configuration aliasesConfiguration = null;
            XMLConfigBuilder xmlConfigBuilder = null;
            ResourcePatternResolver resolver = new PathMatchingResourcePatternResolver();
            antTypeAliasesMap = new HashMap<String, Class<?>>();
            String[] aliasesPackages = antTypeAliasesLocations.split(",");
            for (int i = 0; i < aliasesPackages.length; i++) {
                String aliases = aliasesPackages[i];
                aliases = (aliases + "").trim();
                LOGGER.debug("Parsed type aliases package file: [" + aliases + "]");
                if (aliases != null && aliases.length() > 0) {
                    Resource[] aliasesLocations = resolver.getResources(aliases);
                    if (!isEmpty(aliasesLocations)) {
                        for (Resource aliasesLocation : aliasesLocations) {
                            if (aliasesLocation == null) {
                                continue;
                            }
                            try {
                                if (aliasesLocation != null) {
                                    xmlConfigBuilder = new XMLConfigBuilder(aliasesLocation.getInputStream(), null, this.configurationProperties);
                                    xmlConfigBuilder.parse();
                                    aliasesConfiguration = xmlConfigBuilder.getConfiguration();
                                }
                                if (null != aliasesConfiguration) {
                                    TypeAliasRegistry aliasesRegistry = aliasesConfiguration.getTypeAliasRegistry();
                                    for (Entry<String, Class<?>> alias : aliasesRegistry.getTypeAliases().entrySet()) {
                                        antTypeAliasesMap.put(alias.getKey(), alias.getValue());
                                    }
    
                                }
                            } catch (Exception e) {
                                throw new NestedIOException("Failed to parse mapping resource: '" + aliasesLocation + "'", e);
                            } finally {
                                ErrorContext.instance().reset();
                            }
                            if (LOGGER.isDebugEnabled()) {
                                LOGGER.debug("Parsed mapper file: '" + aliasesLocation + "'");
                            }
                        }
                    }
                }
            }
        }
        return antTypeAliasesMap;
    }
    
    /**
     * {@inheritDoc}
     */
    @Override
    public SqlSessionFactory getObject() throws Exception
    {
        if (this.sqlSessionFactory == null) {
            afterPropertiesSet();
        }
    
        return this.sqlSessionFactory;
    }
    /**
     * {@inheritDoc}
     */
    @Override
    public Class<? extends SqlSessionFactory> getObjectType()
    {
        return this.sqlSessionFactory == null ? SqlSessionFactory.class : this.sqlSessionFactory.getClass();
    }
    
    /**
     * {@inheritDoc}
     */
    @Override
    public boolean isSingleton()
    {
        return true;
    }
    
    /**
     * {@inheritDoc}
     */
    @Override
    public void onApplicationEvent(ApplicationEvent event)
    {
        if (failFast && event instanceof ContextRefreshedEvent) {
            // fail-fast -> check all statements are completed
            this.sqlSessionFactory.getConfiguration().getMappedStatementNames();
        }
    }
    
    /**
     * Sets the ObjectFactory.
     * 
     * @since 1.1.2
     * @param objectFactory
     */
    public void setObjectFactory(ObjectFactory objectFactory)
    {
        this.objectFactory = objectFactory;
    }
    
    /**
     * Sets the ObjectWrapperFactory.
     * 
     * @since 1.1.2
     * @param objectWrapperFactory
     */
    public void setObjectWrapperFactory(ObjectWrapperFactory objectWrapperFactory)
    {
        this.objectWrapperFactory = objectWrapperFactory;
    }
    
    /**
     * Gets the DatabaseIdProvider
     * 
     * @since 1.1.0
     * @return
     */
    public DatabaseIdProvider getDatabaseIdProvider()
    {
        return databaseIdProvider;
    }
    
    /**
     * Sets the DatabaseIdProvider. As of version 1.2.2 this variable is not
     * initialized by default.
     * 
     * @since 1.1.0
     * @param databaseIdProvider
     */
    public void setDatabaseIdProvider(DatabaseIdProvider databaseIdProvider)
    {
        this.databaseIdProvider = databaseIdProvider;
    }
    
    /**
     * Mybatis plugin list.
     * 
     * @since 1.0.1
     * 
     * @param plugins list of plugins
     * 
     */
    public void setPlugins(Interceptor[] plugins)
    {
        this.plugins = plugins;
    }
    
    /**
     * Packages to search for type aliases.
     * 
     * @since 1.0.1
     * 
     * @param typeAliasesPackage package to scan for domain objects
     * 
     */
    public void setTypeAliasesPackage(String typeAliasesPackage)
    {
        this.typeAliasesPackage = typeAliasesPackage;
    }
    
    /**
     * Super class which domain objects have to extend to have a type alias
     * created. No effect if there is no package to scan configured.
     * 
     * @since 1.1.2
     * 
     * @param typeAliasesSuperType super class for domain objects
     * 
     */
    public void setTypeAliasesSuperType(Class<?> typeAliasesSuperType)
    {
        this.typeAliasesSuperType = typeAliasesSuperType;
    }
    
    /**
     * Packages to search for type handlers.
     * 
     * @since 1.0.1
     * 
     * @param typeHandlersPackage package to scan for type handlers
     * 
     */
    public void setTypeHandlersPackage(String typeHandlersPackage)
    {
        this.typeHandlersPackage = typeHandlersPackage;
    }
    
    /**
     * Set type handlers. They must be annotated with {@code MappedTypes} and
     * optionally with {@code MappedJdbcTypes}
     * 
     * @since 1.0.1
     * 
     * @param typeHandlers Type handler list
     */
    public void setTypeHandlers(TypeHandler<?>[] typeHandlers)
    {
        this.typeHandlers = typeHandlers;
    }
    
    /**
     * List of type aliases to register. They can be annotated with
     * {@code Alias}
     * 
     * @since 1.0.1
     * 
     * @param typeAliases Type aliases list
     */
    public void setTypeAliases(Class<?>[] typeAliases)
    {
        this.typeAliases = typeAliases;
    }
    
    /**
     * If true, a final check is done on Configuration to assure that all mapped
     * statements are fully loaded and there is no one still pending to resolve
     * includes. Defaults to false.
     * 
     * @since 1.0.1
     * 
     * @param failFast enable failFast
     */
    public void setFailFast(boolean failFast)
    {
        this.failFast = failFast;
    }
    
    /**
     * Set the location of the MyBatis {@code SqlSessionFactory} config file. A
     * typical value is "WEB-INF/mybatis-configuration.xml".
     */
    public void setConfigLocation(Resource configLocation)
    {
        this.configLocation = configLocation;
    }
    
    /**
     * Set locations of MyBatis mapper files that are going to be merged into
     * the {@code SqlSessionFactory} configuration at runtime.
     * 
     * This is an alternative to specifying "&lt;sqlmapper&gt;" entries in an
     * MyBatis config file. This property being based on Spring's resource
     * abstraction also allows for specifying resource patterns here: e.g.
     * "classpath*:sqlmap/*-mapper.xml".
     */
    public void setMapperLocations(Resource[] mapperLocations)
    {
        this.mapperLocations = mapperLocations;
    }
    
    /**
     * Set optional properties to be passed into the SqlSession configuration,
     * as alternative to a {@code &lt;properties&gt;} tag in the configuration
     * xml file. This will be used to resolve placeholders in the config file.
     */
    public void setConfigurationProperties(Properties sqlSessionFactoryProperties)
    {
        this.configurationProperties = sqlSessionFactoryProperties;
    }
    
    /**
     * Set the JDBC {@code DataSource} that this instance should manage
     * transactions for. The {@code DataSource} should match the one used by the
     * {@code SqlSessionFactory}: for example, you could specify the same JNDI
     * DataSource for both.
     * 
     * A transactional JDBC {@code Connection} for this {@code DataSource} will
     * be provided to application code accessing this {@code DataSource}
     * directly via {@code DataSourceUtils} or
     * {@code DataSourceTransactionManager}.
     * 
     * The {@code DataSource} specified here should be the target
     * {@code DataSource} to manage transactions for, not a
     * {@code TransactionAwareDataSourceProxy}. Only data access code may work
     * with {@code TransactionAwareDataSourceProxy}, while the transaction
     * manager needs to work on the underlying target {@code DataSource}. If
     * there's nevertheless a {@code TransactionAwareDataSourceProxy} passed in,
     * it will be unwrapped to extract its target {@code DataSource}.
     * 
     */
    public void setDataSource(DataSource dataSource)
    {
        if (dataSource instanceof TransactionAwareDataSourceProxy) {
            // If we got a TransactionAwareDataSourceProxy, we need to perform
            // transactions for its underlying target DataSource, else data
            // access code won't see properly exposed transactions (i.e.
            // transactions for the target DataSource).
            this.dataSource = ((TransactionAwareDataSourceProxy) dataSource).getTargetDataSource();
        } else {
            this.dataSource = dataSource;
        }
    }
    
    /**
     * Sets the {@code SqlSessionFactoryBuilder} to use when creating the
     * {@code SqlSessionFactory}.
     * 
     * This is mainly meant for testing so that mock SqlSessionFactory classes
     * can be injected. By default, {@code SqlSessionFactoryBuilder} creates
     * {@code DefaultSqlSessionFactory} instances.
     * 
     */
    public void setSqlSessionFactoryBuilder(SqlSessionFactoryBuilder sqlSessionFactoryBuilder)
    {
        this.sqlSessionFactoryBuilder = sqlSessionFactoryBuilder;
    }
    
    /**
     * Set the MyBatis TransactionFactory to use. Default is
     * {@code SpringManagedTransactionFactory}
     * 
     * The default {@code SpringManagedTransactionFactory} should be appropriate
     * for all cases: be it Spring transaction management, EJB CMT or plain JTA.
     * If there is no active transaction, SqlSession operations will execute SQL
     * statements non-transactionally.
     * 
     * <b>It is strongly recommended to use the default
     * {@code TransactionFactory}.</b> If not used, any attempt at getting an
     * SqlSession through Spring's MyBatis framework will throw an exception if
     * a transaction is active.
     * 
     * @see SpringManagedTransactionFactory
     * @param transactionFactory the MyBatis TransactionFactory
     */
    public void setTransactionFactory(TransactionFactory transactionFactory)
    {
        this.transactionFactory = transactionFactory;
    }
    
    /**
     * <b>NOTE:</b> This class <em>overrides</em> any {@code Environment} you
     * have set in the MyBatis config file. This is used only as a placeholder
     * name. The default value is
     * {@code SqlSessionFactoryBean.class.getSimpleName()}.
     * 
     * @param environment the environment name
     */
    public void setEnvironment(String environment)
    {
        this.environment = environment;
    }
    
    /**
     * {@inheritDoc}
     */
    @Override
    public void afterPropertiesSet() throws Exception
    {
        notNull(dataSource, "Property 'dataSource' is required");
        notNull(sqlSessionFactoryBuilder, "Property 'sqlSessionFactoryBuilder' is required");
        this.sqlSessionFactory = buildSqlSessionFactory();
    }
    
    public void setAntTypeAliasesLocations(String antTypeAliasesLocations)
    {
        this.antTypeAliasesLocations = antTypeAliasesLocations;
    }

}

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

695

696

697

698

699

700

701

702

703

704

705

706

707

708

709

710

711

712

713

714

715

716

717

718

719

720

721

722

723

724

725

726

727

728

729

730

731

732

733

734

735

736

737

738

739

740

741

742

743

744

745

746

747

748

749

750

751

752

753

754

755

756

757

758

759

760

761

762

763

764

765

766

767

768

769

770

771

772

773

774

775

776

777

778

779

780

781

782

783

784

785

786

787

788

789

790

791

792

793

794

795

796

797

798

799

800

801

802

803

804

805

806

807

808

809

810

811

812

813

814

815

816

817

818

819

820

821

822

823

824

825

826

827

828

829

830

831

832

833

834

835

836

837

838

839

840

841

842

843

844

845

846

847

848

849

850

851

852

853

854

855

856

857

858

859

860

861

862

863

864

865

866

867

868

869

870

871

872

873

874

875

876

877

878

879

880

881

882

883

884

885

886

887

888

889

890

891

892

893

894

895

896

897

898

899

900

901

902

903

904

905

906

907

908

909

910

911

912

913

914

915

916

917

918

919

920

921

922

923

924

925

926

927

928

929

930

931

932

933

934

935

936

937

938

939

940

941

942

943

944

945

946

947

948

949

950

951

952

953

954

955

956

957

958

959

960

961

962

963

964

965

966

967

968

969

970

971

972

973

974

975

976

977

978

979

980

981

982

983

984

985

986

987

988

989

990

991

992

993

994

995

996

997

998

999

1000

1001

1002

1003

1004

1005

1006

1007

1008

1009

1010

1011

1012

1013

1014

1015

1016

1017

1018

1019

1020

1021

1022

1023

1024

1025

1026

1027

1028

1029

1030

1031

1032

1033

1034

1035

1036

1037

1038

1039

1040

1041

1042

1043

1044

1045

1046

1047

1048

1049

1050

1051

1052

1053

1054

1055

1056

1057

1058

1059

1060

1061

1062

1063

1064

1065

1066

1067

1068

1069

1070

1071

1072

1073

1074

1075

1076

1077

1078

1079

1080

1081

1082

1083

1084

1085

1086

1087

1088

1089

1090

1091

1092

1093

1094

1095

1096

1097

1098

1099

1100

1101

1102

1103

1104

1105

1106

1107

1108

1109

1110

1111

1112

1113

1114

1115

1116

1117

1118

1119

1120

1121

1122

1123

1124

1125

1126

1127

1128

1129

1130

1131

1132

1133

1134

1135

1136

1137

1138

1139

1140

1141

1142

1143

1144

1145

1146

1147

1148

1149

1150

1151

1152

1153

1154

1155

1156

1157

1158

1159

1160

1161

1162

1163

1164

1165

1166

1167

1168

1169

1170

1171

1172

1173

1174

1175

1176

1177

1178

1179

1180

1181

1182

1183

1184

1185

1186

1187

1188

1189

1190

1191

1192

1193

1194

1195

1196

1197

1198

1199

1200

1201

1202

1203

1204

1205

1206

1207

1208

1209

1210

1211

1212

1213

1214

1215

1216

1217

1218

1219

1220

1221

1222

1223

1224

1225

1226

1227

1228

1229

1230

1231

1232

1233

1234

1235

1236

1237

1238

1239

1240

1241

1242

1243

1244

1245

1246

1247

1248

1249

package com.kernelstudio.vendor.component.mybatis;

/**

* This file is part of the KernelStudio package.

* For the full copyright and license information, please view the LICENSE file

* that was distributed with this source code.

* @author zhoulin < developer@kernelstudio.com >

* @link http://www.kernelstudio.com

* @version 0.1

* @since 0.1

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

import static org.springframework.util.ObjectUtils.isEmpty;

import static org.springframework.util.StringUtils.hasLength;

import static org.springframework.util.StringUtils.tokenizeToStringArray;

import java.io.IOException;

import java.sql.SQLException;

import java.util.HashMap;

import java.util.Map;

import java.util.Map.Entry;

import java.util.Properties;

import javax.sql.DataSource;

import org.apache.ibatis.builder.xml.XMLConfigBuilder;

import org.apache.ibatis.builder.xml.XMLMapperBuilder;

import org.apache.ibatis.executor.ErrorContext;

import org.apache.ibatis.logging.Log;

import org.apache.ibatis.logging.LogFactory;

import org.apache.ibatis.mapping.DatabaseIdProvider;

import org.apache.ibatis.mapping.Environment;

import org.apache.ibatis.plugin.Interceptor;

import org.apache.ibatis.reflection.factory.ObjectFactory;

import org.apache.ibatis.reflection.wrapper.ObjectWrapperFactory;

import org.apache.ibatis.session.Configuration;

import org.apache.ibatis.session.SqlSessionFactory;

import org.apache.ibatis.session.SqlSessionFactoryBuilder;

import org.apache.ibatis.transaction.TransactionFactory;

import org.apache.ibatis.type.TypeAliasRegistry;

import org.apache.ibatis.type.TypeHandler;

import org.mybatis.spring.transaction.SpringManagedTransactionFactory;

import org.springframework.beans.factory.FactoryBean;

import org.springframework.beans.factory.InitializingBean;

import org.springframework.context.ApplicationEvent;

import org.springframework.context.ApplicationListener;

import org.springframework.context.ConfigurableApplicationContext;

import org.springframework.context.event.ContextRefreshedEvent;

import org.springframework.core.NestedIOException;

import org.springframework.core.io.Resource;

import org.springframework.core.io.support.PathMatchingResourcePatternResolver;

import org.springframework.core.io.support.ResourcePatternResolver;

import org.springframework.jdbc.datasource.TransactionAwareDataSourceProxy;

/**

* {@code FactoryBean} that creates an MyBatis {@code SqlSessionFactory}. This

* is the usual way to set up a shared MyBatis {@code SqlSessionFactory} in a

* Spring application context; the SqlSessionFactory can then be passed to

* MyBatis-based DAOs via dependency injection.

* Either {@code DataSourceTransactionManager} or {@code JtaTransactionManager}

* can be used for transaction demarcation in combination with a

* {@code SqlSessionFactory}. JTA should be used for transactions which span

* multiple databases or when container managed transactions (CMT) are being

* used.

* @author Putthibong Boonbong

* @author Hunter Presnall

* @author Eduardo Macarron

* @see #setConfigLocation

* @see #setDataSource

* @version $Id$

public class SqlSessionFactoryBean implements FactoryBean, InitializingBean, ApplicationListener

{

private static final Log LOGGER = LogFactory.getLog(SqlSessionFactoryBean.class);

private Resource configLocation;

private Resource[] mapperLocations;

private DataSource dataSource;

private TransactionFactory transactionFactory;

private Properties configurationProperties;

private SqlSessionFactoryBuilder sqlSessionFactoryBuilder = new SqlSessionFactoryBuilder();

private SqlSessionFactory sqlSessionFactory;

// EnvironmentAware requires spring 3.1

private String environment = SqlSessionFactoryBean.class.getSimpleName();

private boolean failFast;

private Interceptor[] plugins;

private TypeHandler[] typeHandlers;

private String typeHandlersPackage;

private Class[] typeAliases;

private String typeAliasesPackage;

private Class typeAliasesSuperType;

// issue #19. No default provider.

private DatabaseIdProvider databaseIdProvider;

private ObjectFactory objectFactory;

private ObjectWrapperFactory objectWrapperFactory;

private String antTypeAliasesLocations;

private Map> antTypeAliasesMap;

/**

* Build a {@code SqlSessionFactory} instance.

* The default implementation uses the standard MyBatis

* {@code XMLConfigBuilder} API to build a {@code SqlSessionFactory}

* instance based on an Reader.

* @return SqlSessionFactory

* @throws IOException if loading the config file failed

protected SqlSessionFactory buildSqlSessionFactory() throws IOException

{

Configuration configuration;

XMLConfigBuilder xmlConfigBuilder = null;

if (this.configLocation != null) {

xmlConfigBuilder = new XMLConfigBuilder(this.configLocation.getInputStream(), null, this.configurationProperties);

configuration = xmlConfigBuilder.getConfiguration();

} else {

if (LOGGER.isDebugEnabled()) {

LOGGER.debug("Property 'configLocation' not specified, using default MyBatis Configuration");

}

configuration = new Configuration();

configuration.setVariables(this.configurationProperties);

}

if (this.objectFactory != null) {

configuration.setObjectFactory(this.objectFactory);

}

if (this.objectWrapperFactory != null) {

configuration.setObjectWrapperFactory(this.objectWrapperFactory);

}

if (hasLength(this.typeAliasesPackage)) {

String[] typeAliasPackageArray = tokenizeToStringArray(this.typeAliasesPackage, ConfigurableApplicationContext.CONFIG_LOCATION_DELIMITERS);

for (String packageToScan : typeAliasPackageArray) {

configuration.getTypeAliasRegistry().registerAliases(packageToScan, typeAliasesSuperType == null ? Object.class : typeAliasesSuperType);

if (LOGGER.isDebugEnabled()) {

LOGGER.debug("Scanned package: '" + packageToScan + "' for aliases");

}

// 扩展ant风格的别名配置

buildAntTypeAliasesPackage(configuration);

if (null != this.antTypeAliasesMap && !this.antTypeAliasesMap.isEmpty()) {

for (Entry> typeAlias : this.antTypeAliasesMap.entrySet()) {

configuration.getTypeAliasRegistry().registerAlias(typeAlias.getKey(), typeAlias.getValue());

if (LOGGER.isDebugEnabled()) {

LOGGER.debug("Registered ant type alias: '" + typeAlias.getKey() + "[" + typeAlias.getValue().getName() + "]" + "'");

}

// end

if (!isEmpty(this.typeAliases)) {

for (Class typeAlias : this.typeAliases) {

configuration.getTypeAliasRegistry().registerAlias(typeAlias);

if (LOGGER.isDebugEnabled()) {

LOGGER.debug("Registered type alias: '" + typeAlias + "'");

}

if (!isEmpty(this.plugins)) {

for (Interceptor plugin : this.plugins) {

configuration.addInterceptor(plugin);

if (LOGGER.isDebugEnabled()) {

LOGGER.debug("Registered plugin: '" + plugin + "'");

}

if (hasLength(this.typeHandlersPackage)) {

String[] typeHandlersPackageArray = tokenizeToStringArray(this.typeHandlersPackage, ConfigurableApplicationContext.CONFIG_LOCATION_DELIMITERS);

for (String packageToScan : typeHandlersPackageArray) {

configuration.getTypeHandlerRegistry().register(packageToScan);

if (LOGGER.isDebugEnabled()) {

LOGGER.debug("Scanned package: '" + packageToScan + "' for type handlers");

}

if (!isEmpty(this.typeHandlers)) {

for (TypeHandler typeHandler : this.typeHandlers) {

configuration.getTypeHandlerRegistry().register(typeHandler);

if (LOGGER.isDebugEnabled()) {

LOGGER.debug("Registered type handler: '" + typeHandler + "'");

}

// fix #64 set databaseId before

if (this.databaseIdProvider != null) {

// parse mapper xmls

try {

configuration.setDatabaseId(this.databaseIdProvider.getDatabaseId(this.dataSource));

} catch (SQLException e) {

throw new NestedIOException("Failed getting a databaseId", e);

}

if (xmlConfigBuilder != null) {

try {

xmlConfigBuilder.parse();

if (LOGGER.isDebugEnabled()) {

LOGGER.debug("Parsed configuration file: '" + this.configLocation + "'");

}

} catch (Exception ex) {

throw new NestedIOException("Failed to parse config resource: " + this.configLocation, ex);

} finally {

ErrorContext.instance().reset();

}

if (this.transactionFactory == null) {

this.transactionFactory = new SpringManagedTransactionFactory();

}

configuration.setEnvironment(new Environment(this.environment, this.transactionFactory, this.dataSource));

if (!isEmpty(this.mapperLocations)) {

for (Resource mapperLocation : this.mapperLocations) {

if (mapperLocation == null) {

continue;

}

try {

XMLMapperBuilder xmlMapperBuilder = new XMLMapperBuilder(mapperLocation.getInputStream(), configuration, mapperLocation.toString(),

configuration.getSqlFragments());

xmlMapperBuilder.parse();

} catch (Exception e) {

throw new NestedIOException("Failed to parse mapping resource: '" + mapperLocation + "'", e);

} finally {

ErrorContext.instance().reset();

}

if (LOGGER.isDebugEnabled()) {

LOGGER.debug("Parsed mapper file: '" + mapperLocation + "'");

}

} else {

if (LOGGER.isDebugEnabled()) {

LOGGER.debug("Property 'mapperLocations' was not specified or no matching resources found");

}

return this.sqlSessionFactoryBuilder.build(configuration);

}

/**

* @param configuration

* @throws IOException

private Map> buildAntTypeAliasesPackage(Configuration configuration) throws IOException

{

if (antTypeAliasesLocations != null) {

Configuration aliasesConfiguration = null;

XMLConfigBuilder xmlConfigBuilder = null;

ResourcePatternResolver resolver = new PathMatchingResourcePatternResolver();

antTypeAliasesMap = new HashMap>();

String[] aliasesPackages = antTypeAliasesLocations.split(",");

for (int i = 0; i < aliasesPackages.length; i++) {

String aliases = aliasesPackages[i];

aliases = (aliases + "").trim();

LOGGER.debug("Parsed type aliases package file: [" + aliases + "]");

if (aliases != null && aliases.length() > 0) {

Resource[] aliasesLocations = resolver.getResources(aliases);

if (!isEmpty(aliasesLocations)) {

for (Resource aliasesLocation : aliasesLocations) {

if (aliasesLocation == null) {

continue;

}

try {

if (aliasesLocation != null) {

xmlConfigBuilder = new XMLConfigBuilder(aliasesLocation.getInputStream(), null, this.configurationProperties);

xmlConfigBuilder.parse();

aliasesConfiguration = xmlConfigBuilder.getConfiguration();

}

if (null != aliasesConfiguration) {

TypeAliasRegistry aliasesRegistry = aliasesConfiguration.getTypeAliasRegistry();

for (Entry> alias : aliasesRegistry.getTypeAliases().entrySet()) {

antTypeAliasesMap.put(alias.getKey(), alias.getValue());

}

} catch (Exception e) {

throw new NestedIOException("Failed to parse mapping resource: '" + aliasesLocation + "'", e);

} finally {

ErrorContext.instance().reset();

}

if (LOGGER.isDebugEnabled()) {

LOGGER.debug("Parsed mapper file: '" + aliasesLocation + "'");

}

return antTypeAliasesMap;

}

/**

* {@inheritDoc}

@Override

public SqlSessionFactory getObject() throws Exception

{

if (this.sqlSessionFactory == null) {

afterPropertiesSet();

}

return this.sqlSessionFactory;

}

/**

* {@inheritDoc}

@Override

public Class getObjectType()

{

return this.sqlSessionFactory == null ? SqlSessionFactory.class : this.sqlSessionFactory.getClass();

}

/**

* {@inheritDoc}

@Override

public boolean isSingleton()

{

return true;

}

/**

* {@inheritDoc}

@Override

public void onApplicationEvent(ApplicationEvent event)

{

if (failFast && event instanceof ContextRefreshedEvent) {

// fail-fast -> check all statements are completed

this.sqlSessionFactory.getConfiguration().getMappedStatementNames();

}

/**

* Sets the ObjectFactory.

* @since 1.1.2

* @param objectFactory

public void setObjectFactory(ObjectFactory objectFactory)

{

this.objectFactory = objectFactory;

}

/**

* Sets the ObjectWrapperFactory.

* @since 1.1.2

* @param objectWrapperFactory

public void setObjectWrapperFactory(ObjectWrapperFactory objectWrapperFactory)

{

this.objectWrapperFactory = objectWrapperFactory;

}

/**

* Gets the DatabaseIdProvider

* @since 1.1.0

* @return

public DatabaseIdProvider getDatabaseIdProvider()

{

return databaseIdProvider;

}

/**

* Sets the DatabaseIdProvider. As of version 1.2.2 this variable is not

* initialized by default.

* @since 1.1.0

* @param databaseIdProvider

public void setDatabaseIdProvider(DatabaseIdProvider databaseIdProvider)

{

this.databaseIdProvider = databaseIdProvider;

}

/**

* Mybatis plugin list.

* @since 1.0.1

* @param plugins list of plugins

public void setPlugins(Interceptor[] plugins)

{

this.plugins = plugins;

}

/**

* Packages to search for type aliases.

* @since 1.0.1

* @param typeAliasesPackage package to scan for domain objects

public void setTypeAliasesPackage(String typeAliasesPackage)

{

this.typeAliasesPackage = typeAliasesPackage;

}

/**

* Super class which domain objects have to extend to have a type alias

* created. No effect if there is no package to scan configured.

* @since 1.1.2

* @param typeAliasesSuperType super class for domain objects

public void setTypeAliasesSuperType(Class typeAliasesSuperType)

{

this.typeAliasesSuperType = typeAliasesSuperType;

}

/**

* Packages to search for type handlers.

* @since 1.0.1

* @param typeHandlersPackage package to scan for type handlers

public void setTypeHandlersPackage(String typeHandlersPackage)

{

this.typeHandlersPackage = typeHandlersPackage;

}

/**

* Set type handlers. They must be annotated with {@code MappedTypes} and

* optionally with {@code MappedJdbcTypes}

* @since 1.0.1

* @param typeHandlers Type handler list

public void setTypeHandlers(TypeHandler[] typeHandlers)

{

this.typeHandlers = typeHandlers;

}

/**

* List of type aliases to register. They can be annotated with

* {@code Alias}

* @since 1.0.1

* @param typeAliases Type aliases list

public void setTypeAliases(Class[] typeAliases)

{

this.typeAliases = typeAliases;

}

/**

* If true, a final check is done on Configuration to assure that all mapped

* statements are fully loaded and there is no one still pending to resolve

* includes. Defaults to false.

* @since 1.0.1

* @param failFast enable failFast

public void setFailFast(boolean failFast)

{

this.failFast = failFast;

}

/**

* Set the location of the MyBatis {@code SqlSessionFactory} config file. A

* typical value is "WEB-INF/mybatis-configuration.xml".

public void setConfigLocation(Resource configLocation)

{

this.configLocation = configLocation;

}

/**

* Set locations of MyBatis mapper files that are going to be merged into

* the {@code SqlSessionFactory} configuration at runtime.

* This is an alternative to specifying "<sqlmapper>" entries in an

* MyBatis config file. This property being based on Spring's resource

* abstraction also allows for specifying resource patterns here: e.g.

* "classpath*:sqlmap/*-mapper.xml".

public void setMapperLocations(Resource[] mapperLocations)

{

this.mapperLocations = mapperLocations;

}

/**

* Set optional properties to be passed into the SqlSession configuration,

* as alternative to a {@code <properties>} tag in the configuration

* xml file. This will be used to resolve placeholders in the config file.

public void setConfigurationProperties(Properties sqlSessionFactoryProperties)

{

this.configurationProperties = sqlSessionFactoryProperties;

}

/**

* Set the JDBC {@code DataSource} that this instance should manage

* transactions for. The {@code DataSource} should match the one used by the

* {@code SqlSessionFactory}: for example, you could specify the same JNDI

* DataSource for both.

* A transactional JDBC {@code Connection} for this {@code DataSource} will

* be provided to application code accessing this {@code DataSource}

* directly via {@code DataSourceUtils} or

* {@code DataSourceTransactionManager}.

* The {@code DataSource} specified here should be the target

* {@code DataSource} to manage transactions for, not a

* {@code TransactionAwareDataSourceProxy}. Only data access code may work

* with {@code TransactionAwareDataSourceProxy}, while the transaction

* manager needs to work on the underlying target {@code DataSource}. If

* there's nevertheless a {@code TransactionAwareDataSourceProxy} passed in,

* it will be unwrapped to extract its target {@code DataSource}.

public void setDataSource(DataSource dataSource)

{

if (dataSource instanceof TransactionAwareDataSourceProxy) {

// If we got a TransactionAwareDataSourceProxy, we need to perform

// transactions for its underlying target DataSource, else data

// access code won't see properly exposed transactions (i.e.

// transactions for the target DataSource).

this.dataSource = ((TransactionAwareDataSourceProxy) dataSource).getTargetDataSource();

} else {

this.dataSource = dataSource;

}

/**

* Sets the {@code SqlSessionFactoryBuilder} to use when creating the

* {@code SqlSessionFactory}.

* This is mainly meant for testing so that mock SqlSessionFactory classes

* can be injected. By default, {@code SqlSessionFactoryBuilder} creates

* {@code DefaultSqlSessionFactory} instances.

public void setSqlSessionFactoryBuilder(SqlSessionFactoryBuilder sqlSessionFactoryBuilder)

{

this.sqlSessionFactoryBuilder = sqlSessionFactoryBuilder;

}

/**

* Set the MyBatis TransactionFactory to use. Default is

* {@code SpringManagedTransactionFactory}

* The default {@code SpringManagedTransactionFactory} should be appropriate

* for all cases: be it Spring transaction management, EJB CMT or plain JTA.

* If there is no active transaction, SqlSession operations will execute SQL

* statements non-transactionally.

* It is strongly recommended to use the default

* {@code TransactionFactory}. If not used, any attempt at getting an

* SqlSession through Spring's MyBatis framework will throw an exception if

* a transaction is active.

* @see SpringManagedTransactionFactory

* @param transactionFactory the MyBatis TransactionFactory

public void setTransactionFactory(TransactionFactory transactionFactory)

{

this.transactionFactory = transactionFactory;

}

/**

* NOTE: This class overrides any {@code Environment} you

* have set in the MyBatis config file. This is used only as a placeholder

* name. The default value is

* {@code SqlSessionFactoryBean.class.getSimpleName()}.

* @param environment the environment name

public void setEnvironment(String environment)

{

this.environment = environment;

}

/**

* {@inheritDoc}

@Override

public void afterPropertiesSet() throws Exception

{

notNull(dataSource, "Property 'dataSource' is required");

notNull(sqlSessionFactoryBuilder, "Property 'sqlSessionFactoryBuilder' is required");

this.sqlSessionFactory = buildSqlSessionFactory();

}

public void setAntTypeAliasesLocations(String antTypeAliasesLocations)

{

this.antTypeAliasesLocations = antTypeAliasesLocations;

}

Lastme

在 SpringMVC 中扩展MyBatis 的 SqlSessionFactoryBean使其支持 Apache Ant 路径匹配的TypeAliases 配置方式

No Comments

Leave A Reply.

Archives

Meta