# mybatis/spring architecture

> Architecture diagram of the GitHub repository mybatis/spring, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-11). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/mybatis/spring
- Repository: https://github.com/mybatis/spring

## Overview

MyBatis-Spring bridges Spring applications to MyBatis: configuration creates a session factory, mapper scanning registers mapper beans, and application code uses Spring-managed sessions for SQL operations. It also provides DAO support, Spring transaction integration, exception translation, logging, and Spring Batch readers and writers. The graph follows documented capabilities and relationships listed in the source index; unsampled subsystems are included at their known source paths, with uncertain links omitted.

Main entry points: [`src/main/java/org/mybatis/spring/SqlSessionTemplate.java`](https://github.com/mybatis/spring/blob/master/src/main/java/org/mybatis/spring/SqlSessionTemplate.java) (Session template), [`src/main/java/org/mybatis/spring/SqlSessionFactoryBean.java`](https://github.com/mybatis/spring/blob/master/src/main/java/org/mybatis/spring/SqlSessionFactoryBean.java) (Session factory bean), [`src/main/java/org/mybatis/spring/transaction/SpringManagedTransaction.java`](https://github.com/mybatis/spring/blob/master/src/main/java/org/mybatis/spring/transaction/SpringManagedTransaction.java) (Managed transaction), [`src/main/java/org/mybatis/spring/mapper/MapperScannerConfigurer.java`](https://github.com/mybatis/spring/blob/master/src/main/java/org/mybatis/spring/mapper/MapperScannerConfigurer.java) (Scanner configurer)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_setup["Configuration and scanning"]
  node_factory["Session factory bean"]
  node_annotation["Annotation scanning"]
  node_xmlscan["XML scan parser"]
  node_scannerconfig["Scanner configurer"]
  node_scanner["Mapper scanner"]
  node_mapperfactory["Mapper factory bean"]
end

subgraph group_sessions["Sessions and exceptions"]
  node_template["Session template"]
  node_sessionutils["Session utilities"]
  node_sessionholder["Session holder"]
  node_translator["Exception translator"]
  node_systemexception["System exception"]
  node_daosupport["DAO support"]
end

subgraph group_transactions["Spring transactions"]
  node_transactionfactory["Transaction factory"]
  node_transaction["Managed transaction"]
end

subgraph group_batch["Batch integration"]
  node_batchwriter["Batch writer"]
  node_cursorreader["Cursor reader"]
  node_pagingreader["Paging reader"]
end

subgraph group_support["Support utilities"]
  node_loggingfactory["Logger factory<br/>[LoggerFactory.java]"]
  node_logger["Logger wrapper<br/>[Logger.java]"]
end

node_application(("Spring application"))
node_mybatis["MyBatis"]
node_spring["Spring Framework"]
node_springbatch["Spring Batch"]
node_database[("Database")]

node_application -.->|"configures"| node_factory
node_factory -->|"configures"| node_transactionfactory
node_factory -.->|"creates factory"| node_mybatis
node_application -->|"declares scans"| node_annotation
node_application -.->|"declares scan"| node_xmlscan
node_annotation -->|"registers"| node_scannerconfig
node_xmlscan -->|"configures"| node_scannerconfig
node_scannerconfig -->|"creates"| node_scanner
node_scanner -->|"registers"| node_mapperfactory
node_mapperfactory -->|"uses"| node_template
node_application -.->|"executes SQL"| node_template
node_template -->|"manages sessions"| node_sessionutils
node_template -->|"translates errors"| node_translator
node_translator -->|"wraps exceptions"| node_systemexception
node_sessionutils -->|"uses holder"| node_sessionholder
node_template -.->|"dispatches calls"| node_mybatis
node_daosupport -->|"creates or uses"| node_template
node_transactionfactory -->|"creates"| node_transaction
node_transaction -.->|"uses transactions"| node_spring
node_transaction -.->|"accesses connection"| node_database
node_batchwriter -->|"writes through"| node_template
node_springbatch -.->|"invokes writer"| node_batchwriter
node_springbatch -.->|"uses reader"| node_cursorreader
node_springbatch -.->|"uses reader"| node_pagingreader
node_pagingreader -->|"uses"| node_template
node_loggingfactory -->|"creates"| node_logger

click node_factory "https://github.com/mybatis/spring/blob/master/src/main/java/org/mybatis/spring/SqlSessionFactoryBean.java"
click node_annotation "https://github.com/mybatis/spring/blob/master/src/main/java/org/mybatis/spring/annotation/MapperScannerRegistrar.java"
click node_xmlscan "https://github.com/mybatis/spring/blob/master/src/main/java/org/mybatis/spring/config/MapperScannerBeanDefinitionParser.java"
click node_scannerconfig "https://github.com/mybatis/spring/blob/master/src/main/java/org/mybatis/spring/mapper/MapperScannerConfigurer.java"
click node_scanner "https://github.com/mybatis/spring/blob/master/src/main/java/org/mybatis/spring/mapper/ClassPathMapperScanner.java"
click node_mapperfactory "https://github.com/mybatis/spring/blob/master/src/main/java/org/mybatis/spring/mapper/MapperFactoryBean.java"
click node_template "https://github.com/mybatis/spring/blob/master/src/main/java/org/mybatis/spring/SqlSessionTemplate.java"
click node_sessionutils "https://github.com/mybatis/spring/blob/master/src/main/java/org/mybatis/spring/SqlSessionUtils.java"
click node_sessionholder "https://github.com/mybatis/spring/blob/master/src/main/java/org/mybatis/spring/SqlSessionHolder.java"
click node_translator "https://github.com/mybatis/spring/blob/master/src/main/java/org/mybatis/spring/MyBatisExceptionTranslator.java"
click node_systemexception "https://github.com/mybatis/spring/blob/master/src/main/java/org/mybatis/spring/MyBatisSystemException.java"
click node_daosupport "https://github.com/mybatis/spring/blob/master/src/main/java/org/mybatis/spring/support/SqlSessionDaoSupport.java"
click node_transactionfactory "https://github.com/mybatis/spring/blob/master/src/main/java/org/mybatis/spring/transaction/SpringManagedTransactionFactory.java"
click node_transaction "https://github.com/mybatis/spring/blob/master/src/main/java/org/mybatis/spring/transaction/SpringManagedTransaction.java"
click node_batchwriter "https://github.com/mybatis/spring/blob/master/src/main/java/org/mybatis/spring/batch/MyBatisBatchItemWriter.java"
click node_cursorreader "https://github.com/mybatis/spring/blob/master/src/main/java/org/mybatis/spring/batch/MyBatisCursorItemReader.java"
click node_pagingreader "https://github.com/mybatis/spring/blob/master/src/main/java/org/mybatis/spring/batch/MyBatisPagingItemReader.java"
click node_loggingfactory "https://github.com/mybatis/spring/blob/master/src/main/java/org/mybatis/logging/LoggerFactory.java"
click node_logger "https://github.com/mybatis/spring/blob/master/src/main/java/org/mybatis/logging/Logger.java"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_factory,node_annotation,node_xmlscan,node_scannerconfig,node_scanner,node_mapperfactory toneBlue
class node_template,node_sessionutils,node_sessionholder,node_translator,node_systemexception,node_daosupport,node_database toneAmber
class node_transactionfactory,node_transaction toneMint
class node_batchwriter,node_cursorreader,node_pagingreader toneRose
class node_loggingfactory,node_logger,node_application,node_mybatis,node_spring,node_springbatch toneIndigo
```

## Components

### Configuration and scanning

- [Session factory bean](https://github.com/mybatis/spring/blob/master/src/main/java/org/mybatis/spring/SqlSessionFactoryBean.java): `src/main/java/org/mybatis/spring/SqlSessionFactoryBean.java`
- [Annotation scanning](https://github.com/mybatis/spring/blob/master/src/main/java/org/mybatis/spring/annotation/MapperScannerRegistrar.java): `src/main/java/org/mybatis/spring/annotation/MapperScannerRegistrar.java`
- [XML scan parser](https://github.com/mybatis/spring/blob/master/src/main/java/org/mybatis/spring/config/MapperScannerBeanDefinitionParser.java): `src/main/java/org/mybatis/spring/config/MapperScannerBeanDefinitionParser.java`
- [Scanner configurer](https://github.com/mybatis/spring/blob/master/src/main/java/org/mybatis/spring/mapper/MapperScannerConfigurer.java): `src/main/java/org/mybatis/spring/mapper/MapperScannerConfigurer.java`
- [Mapper scanner](https://github.com/mybatis/spring/blob/master/src/main/java/org/mybatis/spring/mapper/ClassPathMapperScanner.java): `src/main/java/org/mybatis/spring/mapper/ClassPathMapperScanner.java`
- [Mapper factory bean](https://github.com/mybatis/spring/blob/master/src/main/java/org/mybatis/spring/mapper/MapperFactoryBean.java): `src/main/java/org/mybatis/spring/mapper/MapperFactoryBean.java`

### Sessions and exceptions

- [Session template](https://github.com/mybatis/spring/blob/master/src/main/java/org/mybatis/spring/SqlSessionTemplate.java): `src/main/java/org/mybatis/spring/SqlSessionTemplate.java`
- [Session utilities](https://github.com/mybatis/spring/blob/master/src/main/java/org/mybatis/spring/SqlSessionUtils.java): `src/main/java/org/mybatis/spring/SqlSessionUtils.java`
- [Session holder](https://github.com/mybatis/spring/blob/master/src/main/java/org/mybatis/spring/SqlSessionHolder.java): `src/main/java/org/mybatis/spring/SqlSessionHolder.java`
- [Exception translator](https://github.com/mybatis/spring/blob/master/src/main/java/org/mybatis/spring/MyBatisExceptionTranslator.java): `src/main/java/org/mybatis/spring/MyBatisExceptionTranslator.java`
- [System exception](https://github.com/mybatis/spring/blob/master/src/main/java/org/mybatis/spring/MyBatisSystemException.java): `src/main/java/org/mybatis/spring/MyBatisSystemException.java`
- [DAO support](https://github.com/mybatis/spring/blob/master/src/main/java/org/mybatis/spring/support/SqlSessionDaoSupport.java): `src/main/java/org/mybatis/spring/support/SqlSessionDaoSupport.java`

### Spring transactions

- [Transaction factory](https://github.com/mybatis/spring/blob/master/src/main/java/org/mybatis/spring/transaction/SpringManagedTransactionFactory.java): `src/main/java/org/mybatis/spring/transaction/SpringManagedTransactionFactory.java`
- [Managed transaction](https://github.com/mybatis/spring/blob/master/src/main/java/org/mybatis/spring/transaction/SpringManagedTransaction.java): `src/main/java/org/mybatis/spring/transaction/SpringManagedTransaction.java`

### Batch integration

- [Batch writer](https://github.com/mybatis/spring/blob/master/src/main/java/org/mybatis/spring/batch/MyBatisBatchItemWriter.java): `src/main/java/org/mybatis/spring/batch/MyBatisBatchItemWriter.java`
- [Cursor reader](https://github.com/mybatis/spring/blob/master/src/main/java/org/mybatis/spring/batch/MyBatisCursorItemReader.java): `src/main/java/org/mybatis/spring/batch/MyBatisCursorItemReader.java`
- [Paging reader](https://github.com/mybatis/spring/blob/master/src/main/java/org/mybatis/spring/batch/MyBatisPagingItemReader.java): `src/main/java/org/mybatis/spring/batch/MyBatisPagingItemReader.java`

### Support utilities

- [Logger factory](https://github.com/mybatis/spring/blob/master/src/main/java/org/mybatis/logging/LoggerFactory.java): `src/main/java/org/mybatis/logging/LoggerFactory.java`
- [Logger wrapper](https://github.com/mybatis/spring/blob/master/src/main/java/org/mybatis/logging/Logger.java): `src/main/java/org/mybatis/logging/Logger.java`

### Other components

- **Spring application**
- **MyBatis**
- **Spring Framework**
- **Spring Batch**
- **Database**

## Connections

- Spring application → Session factory bean: configures (evidence: `README.md`)
- Session factory bean → Transaction factory: configures (evidence: `src/main/java/org/mybatis/spring/SqlSessionFactoryBean.java`)
- Session factory bean → MyBatis: creates factory
- Spring application → Annotation scanning: declares scans (evidence: `src/main/java/org/mybatis/spring/annotation/MapperScannerRegistrar.java`)
- Spring application → XML scan parser: declares scan (evidence: `src/main/java/org/mybatis/spring/config/MapperScannerBeanDefinitionParser.java`)
- Annotation scanning → Scanner configurer: registers (evidence: `src/main/java/org/mybatis/spring/annotation/MapperScannerRegistrar.java`)
- XML scan parser → Scanner configurer: configures (evidence: `src/main/java/org/mybatis/spring/config/MapperScannerBeanDefinitionParser.java`)
- Scanner configurer → Mapper scanner: creates (evidence: `src/main/java/org/mybatis/spring/mapper/MapperScannerConfigurer.java`)
- Mapper scanner → Mapper factory bean: registers (evidence: `src/main/java/org/mybatis/spring/mapper/ClassPathMapperScanner.java`)
- Mapper factory bean → Session template: uses (evidence: `src/main/java/org/mybatis/spring/mapper/MapperFactoryBean.java`)
- Spring application → Session template: executes SQL (evidence: `README.md`)
- Session template → Session utilities: manages sessions (evidence: `src/main/java/org/mybatis/spring/SqlSessionTemplate.java`)
- Session template → Exception translator: translates errors (evidence: `src/main/java/org/mybatis/spring/SqlSessionTemplate.java`)
- Exception translator → System exception: wraps exceptions (evidence: `src/main/java/org/mybatis/spring/MyBatisExceptionTranslator.java`)
- Session utilities → Session holder: uses holder (evidence: `src/main/java/org/mybatis/spring/SqlSessionUtils.java`)
- Session template → MyBatis: dispatches calls
- DAO support → Session template: creates or uses (evidence: `src/main/java/org/mybatis/spring/support/SqlSessionDaoSupport.java`)
- Transaction factory → Managed transaction: creates (evidence: `src/main/java/org/mybatis/spring/transaction/SpringManagedTransactionFactory.java`)
- Managed transaction → Spring Framework: uses transactions
- Managed transaction → Database: accesses connection
- Batch writer → Session template: writes through (evidence: `src/main/java/org/mybatis/spring/batch/MyBatisBatchItemWriter.java`)
- Spring Batch → Batch writer: invokes writer (evidence: `README.md`)
- Spring Batch → Cursor reader: uses reader (evidence: `README.md`)
- Spring Batch → Paging reader: uses reader (evidence: `README.md`)
- Paging reader → Session template: uses (evidence: `src/main/java/org/mybatis/spring/batch/MyBatisPagingItemReader.java`)
- Logger factory → Logger wrapper: creates (evidence: `src/main/java/org/mybatis/logging/LoggerFactory.java`)
