How mybatis/mybatis-3 works
Project Type and Purpose
• This is an open‑source Java library/framework (MyBatis SQL Mapper) for mapping Java objects to SQL queries.
• Not a web or full‑stack app, but a reusable core component that sits between user code and the database (via JDBC).
Key Layers & Directories
• src/main/java/org/apache/ibatis/annotations → annotation‑driven mapper definitions
• src/main/java/org/apache/ibatis/builder → builders for configuration and SQL mappings (XML & annotation)
• src/main/java/org/apache/ibatis/binding → mapper proxy, registry, and invocation logic
• src/main/java/org/apache/ibatis/cache → caching interfaces, decorators, implementations
• src/main/java/org/apache/ibatis/executor → core execution layer (SimpleExecutor, BatchExecutor, CachingExecutor)
• src/main/java/org/apache/ibatis/session → SqlSession, SqlSessionFactory, Configuration classes
• src/main/java/org/apache/ibatis/datasource → DataSource factories (pooled, unpooled, JNDI)
• src/main/java/org/apache/ibatis/type → type handler registry and handlers for JDBC-to-Java conversions
• Additional modules: io, logging, parsing, scripting, plugin, reflection, transaction, jdbc
Main Components
A. User Application
• Calls MyBatis API (SqlSessionFactoryBuilder → SqlSessionFactory → SqlSession).
B. Configuration & Builder
• XMLConfigBuilder & MapperAnnotationBuilder read XML/annotations → build Configuration.
• Configuration holds MappedStatements, TypeAliasRegistry, TypeHandlerRegistry, Environment (DataSource + TransactionFactory).
C. SqlSession Layer
• SqlSessionFactory creates SqlSession.
• SqlSession provides mapper proxies (MapperProxy) and direct query methods.
D. Executor Layer
• Executor (SimpleExecutor / BatchExecutor / ReuseExecutor / CachingExecutor)
• StatementHandler prepares JDBC statements, ParameterHandler populates parameters, ResultSetHandler maps rows.
E. Caching Layer (optional decorator around Executor)
F. Transaction & DataSource
• TransactionFactory creates Transactions (JdbcTransaction or ManagedTransaction).
• DataSourceFactory supplies Connection objects.
G. JDBC & Database
• JDBC Driver
• Underlying relational database
Relationships & Data Flow
• 1: User App → calls SqlSessionFactoryBuilder with config file → built Configuration
• 2: Configuration → SqlSessionFactory → SqlSession
• 3: SqlSession → MapperProxy → invokes MappedStatement
• 4: MappedStatement + Executor → StatementHandler → JDBC Connection
• 5: JDBC → Database → ResultSet → ResultHandler → user object
• Cache decorators intercept before/after step 4 to return cached results.
• PluginChain wraps Executor, StatementHandler, ParameterHandler, ResultSetHandler for interception.
Architectural Patterns & Principles
• Builder pattern for reading/parsing XML or annotations into Configuration.
• Factory pattern in SqlSessionFactoryBuilder, DataSourceFactory, TransactionFactory.
• Proxy pattern for mapper interfaces (MapperProxy).
• Decorator pattern for caching (CachingExecutor wraps a target Executor).
• Template Method in script runners and executors to handle boilerplate JDBC.
• Separation of concerns: distinct packages for builder, binding, executor, session, transaction, caching, type handling.
Extensibility Points
• Plugin/InterceptorChain: intercept core operations (executor.doQuery, parameter mapping, result handling).
• TypeHandlerRegistry: register custom TypeHandler implementations for custom types.
• ObjectFactory & ObjectWrapperFactory for custom instantiation and property mapping.
Must‑Haves
• Clear labels for each component/package