AnnotatedSQL lib - Android में स्वचालित डेटाबेस पीढ़ी

एंड्रॉइड के लिए एक एप्लिकेशन विकसित करते समय, हम अक्सर सर्किट बनाने के लिए अपने हाथों से स्क्रिप्ट लिखते हैं।
सब कुछ ठीक हो जाएगा जब आपको एक बार ऐसा करने की आवश्यकता होती है, लेकिन जब एप्लिकेशन विकसित होता है, तो आपको अक्सर डेटाबेस बदलना पड़ता है।
और जब यह कई वर्गों में फैला होता है, तो समस्याएं होती हैं, कहीं मैं एक कॉलम जोड़ने / निकालने के लिए भूल गया, प्रकार बदलूं और इतने पर। इसके अलावा कॉपी-पेस्ट "मदद": एक कॉलम जोड़ा - एक अल्पविराम लगाने के लिए भूल गया।

बस इन समस्याओं को हल करने के लिए इस पुस्तकालय का आविष्कार किया गया था।



एनोटेटेडएसक्यू एक पुस्तकालय है जो एनोटेशन डेटाबेस बनाने के लिए कोड उत्पन्न करेगा। एनोटेशन रनटाइम नहीं है , लेकिन संकलन समय पर प्रीप्रोसेसर द्वारा संसाधित किया जाता है। इस प्रकार, हम परियोजना और अंतिम apk को प्रभावित नहीं करते हैं।

दरअसल, लिब में दो टुकड़े होते हैं: एनोटेशन और प्रीप्रोसेसर वाला जार।
परियोजना के libs फ़ोल्डर में व्याख्याएँ।
खैर, प्रीप्रोसेसर का उपयोग आईडीई और परियोजना के निर्माण की विधि पर निर्भर करता है।

यदि आप ग्रहण का उपयोग करते हैं, तो प्लग इन प्लगिन फ़ोल्डर में कॉपी करें और यदि आवश्यक हो तो ग्रहण को पुनरारंभ करें। फिर हम जावा कंपाइलर -> एनोटेशन प्रोसेसिंग प्रोजेक्ट की सेटिंग में जाते हैं और उस फोल्डर को चुनते हैं जहां पर कोड जेनरेट करना है। जाहिर है आपको मानक जीन फ़ोल्डर डालने की आवश्यकता है। इसके बाद, Factory Path पर जाएं और हमारे प्लगइन का चयन करें। खैर यह सब है।

आईडीईए के लिए प्लग-इन एकत्र नहीं किया गया, कूड़े

चींटी के साथ उपयोग के लिए - आपको बस क्लासपैथ में एक प्रीप्रोसेसर जोड़ने की जरूरत है, हम इसे कुछ इस तरह से करते हैं
ant clean release -cp ../com.annotatedsql.AnnotatedSQL_1.0.12.jar


के उपयोग

अधिक तकनीकी चीजों पर चलते हैं। तो हम जानते हैं कि लिब को कैसे जोड़ा जाए, लेकिन यह क्या करता है?
जैसा कि मैंने पहले ही कहा है, यह एनोटेशन से एक डेटाबेस बनाता है, या बल्कि, एक वर्ग बनाता है जिसकी मदद से डेटाबेस उत्पन्न होगा।
हमेशा की तरह, कोड में उपयोग के लिए, हम प्लेटों को तालिका के नाम और इसमें स्तंभों के साथ इंटरफेस के रूप में वर्णित करते हैं।

उदाहरण के लिए, हमारे पास एक एप्लिकेशन होगा जो खेल प्रतियोगिताओं के परिणामों पर डेटा प्रदर्शित करेगा। अभी के लिए एक फुटबॉल मैच ले लो।
जाहिर है, हमें डेटाबेस में कई टैग होने चाहिए। यह एक टीम, परिणाम और चैम्पियनशिप है। हम उनका वर्णन करेंगे।
मैं आमतौर पर एक वर्ग के भीतर सभी इंटरफेस का वर्णन करता हूं, चलो इसे FStore कहते हैं, उदाहरण के लिए। गोलियों के विवरण के अलावा, इसमें डेटाबेस का नाम, इसका संस्करण और उपयोगिता विधियों की एक जोड़ी शामिल है।

 public class FStore { public static final String DB_NAME = "fmanager"; public static final int DB_VERSION = 34; .......... public static interface TeamTable{ String TABLE_NAME = "team_table"; String ID = "_id"; String TITLE = "title"; String CHEMP_ID = "chemp_id"; String IS_FAV = "is_fav"; } public static interface ChempTable{ String TABLE_NAME = "chemp_table"; String CONTENT_PATH = "chemps"; String ID = "_id"; String TITLE = "title"; } public static interface ResultsTable{ String CONTENT_PATH = "results"; String PATH_VIEW = "results_view"; String TABLE_NAME = "result_table"; String ID = "_id"; String TEAM_ID = "team_id"; String POINTS = "points"; String CHEMP_ID = "chemp_id"; String GAMES = "games"; String WINS = "wins"; String TIE = "tie"; String LOSE = "lose"; String BALLS = "balls"; String GOALS = "goals"; } ........ } 

जबकि हम CONTENT_PATH और सभी प्रकार के PATH_VIEW पर ध्यान नहीं देते हैं। ये कंटेंट प्रोवाइडर तक पहुंचने के लिए निरंतर हैं।
इसलिए, हम सर्किट बनाने के लिए मैनुअल काम की मात्रा प्रस्तुत करते हैं।
इसके अलावा, एक पठनीय रूप में परिणाम प्राप्त करने के लिए, हमें प्लेटों को एक-दूसरे से जुड़ने की आवश्यकता है। यह सामग्री प्रदाता में किया जा सकता है, लेकिन मैं व्यू का उपयोग करना पसंद करता हूं, यहां लेखन के लिए एक और बड़ा वर्ग टुकड़ा है।

हमारे काम को सुविधाजनक बनाने के लिए, यह परिवाद लिखा गया था। तो चलिए शुरू करते हैं।

योजना

FStore - एनोटेशन स्कीमा ("SqlSchema") के साथ चिह्नित करें और उस वर्ग का नाम सेट करें जिसमें कोड होगा। वर्ग उसी पैकेज में उत्पन्न होगा जहाँ FStore झूठ है

 @Schema("SqlSchema") public class FStore { 

टेबल, इंडेक्स, प्राइमरीके

लेबल विवरण तालिका एनोटेशन और सेट टेबल नाम के साथ चिह्नित है

 @Table(ChempTable.TABLE_NAME) public static interface ChempTable{ ................ @Table(TeamTable.TABLE_NAME) public static interface TeamTable{ ............... @Table(ResultsTable.TABLE_NAME) @Index(name = "chemp_index", columns = ResultsTable.CHEMP_ID) @PrimaryKey(collumns = {ResultsTable.TEAM_ID, ResultsTable.CHEMP_ID}) public static interface ResultsTable{ 

जैसा कि हम मेज पर देखते हैं, हम एक सूचकांक, और एक जटिल कुंजी के निर्माण को लटका सकते हैं। सब कुछ सरल लगता है और किसी भी स्पष्टीकरण की आवश्यकता नहीं है।

कॉलम, प्राइमरीकेय, ऑटोइनक्रीमेंट, नोटनल

ये एनोटेशन खेतों के लिए हैं, और उपयोग करने के लिए स्पष्ट हैं।

  @Table(TeamTable.TABLE_NAME) public static interface TeamTable{ String TABLE_NAME = "team_table"; @PrimaryKey @Column(type = Type.INTEGER) String ID = "_id"; @NotNull @Column(type = Type.TEXT) String TITLE = "title"; @Column(type = Type.INTEGER) @NotNull String CHEMP_ID = "chemp_id"; @Column(type = Type.INTEGER, defVal="0") String IS_FAV = "is_fav"; } 

SimpleView

और अंतिम, बहुत महत्वपूर्ण, सिस्टम का तत्व और काफी तुच्छ नहीं SimpleView है ।
यह सरल दृश्य बनाने के लिए बुनियादी कार्यक्षमता प्रदान करता है। अभी भी एक ININ JOIN है, लेकिन मैं दूसरों को जोड़ूंगा।

  @SimpleView(ResultView.VIEW_NAME) public static interface ResultView{ String VIEW_NAME = "result_view"; @From(ResultsTable.TABLE_NAME) String TABLE_RESULT = "table_result"; @Join(srcTable = TeamTable.TABLE_NAME, srcColumn = TeamTable.ID, destTable = ResultView.TABLE_RESULT, destColumn = ResultsTable.TEAM_ID) String TABLE_TEAM = "table_team"; @Join(srcTable = ChempTable.TABLE_NAME, srcColumn = ChempTable.ID, destTable = ResultView.TABLE_RESULT, destColumn = ResultsTable.CHEMP_ID) String TABLE_CHEMP = "table_chemp"; } 

हमारे विचार के अंदर एनोटेशन पर विचार करें:
से - यह वह टैबलेट है जिसमें से हम :) करेंगे - महत्वपूर्ण - आगे, शामिल होने पर, आपको तालिका नाम का उपयोग नहीं करना चाहिए, लेकिन यह निरंतर है।

सम्मिलित हों - वास्तव में जुड़ने की तालिका। हमारे मामले में, टीम और चैंपियनशिप की तालिका में शामिल होना आवश्यक है।

srcTable स्रोत तालिका है।
डेस्टटेबल व्यू में से / ज्वाइन टेबल के लिए नया नाम है। हमारे मामले में

 String TABLE_RESULT = "table_result"; 

एक और बहुत महत्वपूर्ण बिंदु - दृश्य में, फ़ील्ड नाम निम्न पैटर्न के अनुसार उत्पन्न होते हैं:
<variable_name>_<column_name>

अपवाद तालिका से _id फ़ील्ड है, जो एडाप्टर में कर्सर का उपयोग करेगा।

इसलिए, कॉलम इंडेक्स को खोजने के लिए आपको कुछ का उपयोग करने की आवश्यकता है

 columnPoints = cursor.getColumnIndex(ResultView.TABLE_RESULT + "_" + ResultsTable.POINTS); 

थोड़ा असहज, लेकिन यह एक बार किया जाता है

 public void changeCursor(Cursor cursor) { 

आप अभी भी ऐसे सहायक का उपयोग कर सकते हैं

 public class ColumnMappingHelper { private HashMap<String, HashMap<String, Integer>> indexes = new HashMap<String, HashMap<String, Integer>>(); public int getColumn(Cursor c, String table, String column){ HashMap<String, Integer> columns = indexes.get(table); if(columns != null){ Integer index = columns.get(column); if(index != null) return index; } if(columns == null){ columns = new HashMap<String, Integer>(); indexes.put(table, columns); } int index = c.getColumnIndex(table + "_" + column); columns.put(column, index); return index; } } 

और इस तरह का उपयोग करें

 mappingHelper.getColumn(cursor, ResultView.TABLE_RESULT, ResultsTable.POINTS); 

परिणाम

जनरेट की गई फ़ाइल SqlSchema.java

 public class SqlSchema{ private static final String SQL_CREATE_RESULT_TABLE = "create table result_table( balls INTEGER, chemp_id INTEGER NOT NULL, games INTEGER NOT NULL, goals INTEGER, _id INTEGER, lose INTEGER, points INTEGER NOT NULL, team_id INTEGER NOT NULL, tie INTEGER, wins INTEGER, PRIMARY KEY( team_id, chemp_id))"; private static final String SQL_CREATE_CHEMP_TABLE = "create table chemp_table( _id INTEGER PRIMARY KEY, title TEXT)"; private static final String SQL_CREATE_TEAM_TABLE = "create table team_table( chemp_id INTEGER NOT NULL, _id INTEGER PRIMARY KEY, is_fav INTEGER DEFAULT (0), title TEXT NOT NULL)"; private static final String SQL_CREATE_CHEMP_INDEX = "create index idx_chemp_index on result_table( chemp_id)"; private static final String SQL_CREATE_RESULT_VIEW = "CREATE VIEW result_view AS SELECT table_chemp._id as table_chemp__id, table_chemp.title as table_chemp_title, table_result.balls as table_result_balls, table_result.chemp_id as table_result_chemp_id, table_result.games as table_result_games, table_result.goals as table_result_goals, table_result._id, table_result.lose as table_result_lose, table_result.points as table_result_points, table_result.team_id as table_result_team_id, table_result.tie as table_result_tie, table_result.wins as table_result_wins, table_team.chemp_id as table_team_chemp_id, table_team._id as table_team__id, table_team.is_fav as table_team_is_fav, table_team.title as table_team_title FROM result_table AS table_result JOIN chemp_table AS table_chemp ON table_chemp._id = table_result.chemp_id JOIN team_table AS table_team ON table_team._id = table_result.team_id"; public static void onCreate(final SQLiteDatabase db) { db.execSQL(SQL_CREATE_RESULT_TABLE); db.execSQL(SQL_CREATE_CHEMP_TABLE); db.execSQL(SQL_CREATE_TEAM_TABLE); db.execSQL(SQL_CREATE_SCORE_TABLE); db.execSQL(SQL_CREATE_CHEMP_INDEX); db.execSQL(SQL_CREATE_RESULT_VIEW); db.execSQL(SQL_CREATE_SCORE_VIEW); } public static void onDrop(final SQLiteDatabase db){ db.execSQL("drop table if exists result_table"); db.execSQL("drop table if exists chemp_table"); db.execSQL("drop table if exists team_table"); db.execSQL("drop table if exists score_table"); db.execSQL("drop view if exists result_view"); db.execSQL("drop view if exists score_view"); } } देखें result_view के रूप में चयन table_chemp__id, table_chemp_title रूप table_chemp.title, table_result_balls रूप table_result.balls, table_result_chemp_id रूप table_result.chemp_id, table_result_games रूप table_result.games, table_result_goals रूप table_result.goals, table_result रूप table_chemp._id। public class SqlSchema{ private static final String SQL_CREATE_RESULT_TABLE = "create table result_table( balls INTEGER, chemp_id INTEGER NOT NULL, games INTEGER NOT NULL, goals INTEGER, _id INTEGER, lose INTEGER, points INTEGER NOT NULL, team_id INTEGER NOT NULL, tie INTEGER, wins INTEGER, PRIMARY KEY( team_id, chemp_id))"; private static final String SQL_CREATE_CHEMP_TABLE = "create table chemp_table( _id INTEGER PRIMARY KEY, title TEXT)"; private static final String SQL_CREATE_TEAM_TABLE = "create table team_table( chemp_id INTEGER NOT NULL, _id INTEGER PRIMARY KEY, is_fav INTEGER DEFAULT (0), title TEXT NOT NULL)"; private static final String SQL_CREATE_CHEMP_INDEX = "create index idx_chemp_index on result_table( chemp_id)"; private static final String SQL_CREATE_RESULT_VIEW = "CREATE VIEW result_view AS SELECT table_chemp._id as table_chemp__id, table_chemp.title as table_chemp_title, table_result.balls as table_result_balls, table_result.chemp_id as table_result_chemp_id, table_result.games as table_result_games, table_result.goals as table_result_goals, table_result._id, table_result.lose as table_result_lose, table_result.points as table_result_points, table_result.team_id as table_result_team_id, table_result.tie as table_result_tie, table_result.wins as table_result_wins, table_team.chemp_id as table_team_chemp_id, table_team._id as table_team__id, table_team.is_fav as table_team_is_fav, table_team.title as table_team_title FROM result_table AS table_result JOIN chemp_table AS table_chemp ON table_chemp._id = table_result.chemp_id JOIN team_table AS table_team ON table_team._id = table_result.team_id"; public static void onCreate(final SQLiteDatabase db) { db.execSQL(SQL_CREATE_RESULT_TABLE); db.execSQL(SQL_CREATE_CHEMP_TABLE); db.execSQL(SQL_CREATE_TEAM_TABLE); db.execSQL(SQL_CREATE_SCORE_TABLE); db.execSQL(SQL_CREATE_CHEMP_INDEX); db.execSQL(SQL_CREATE_RESULT_VIEW); db.execSQL(SQL_CREATE_SCORE_VIEW); } public static void onDrop(final SQLiteDatabase db){ db.execSQL("drop table if exists result_table"); db.execSQL("drop table if exists chemp_table"); db.execSQL("drop table if exists team_table"); db.execSQL("drop table if exists score_table"); db.execSQL("drop view if exists result_view"); db.execSQL("drop view if exists score_view"); } } table_team_is_fav रूप table_result_wins रूप table_result_tie रूप table_result_points, table_result_team_id रूप table_result.team_id, table_result.tie, table_result.wins, table_team_chemp_id रूप table_team.chemp_id, table_team__id रूप table_team._id, table_team.is_fav, public class SqlSchema{ private static final String SQL_CREATE_RESULT_TABLE = "create table result_table( balls INTEGER, chemp_id INTEGER NOT NULL, games INTEGER NOT NULL, goals INTEGER, _id INTEGER, lose INTEGER, points INTEGER NOT NULL, team_id INTEGER NOT NULL, tie INTEGER, wins INTEGER, PRIMARY KEY( team_id, chemp_id))"; private static final String SQL_CREATE_CHEMP_TABLE = "create table chemp_table( _id INTEGER PRIMARY KEY, title TEXT)"; private static final String SQL_CREATE_TEAM_TABLE = "create table team_table( chemp_id INTEGER NOT NULL, _id INTEGER PRIMARY KEY, is_fav INTEGER DEFAULT (0), title TEXT NOT NULL)"; private static final String SQL_CREATE_CHEMP_INDEX = "create index idx_chemp_index on result_table( chemp_id)"; private static final String SQL_CREATE_RESULT_VIEW = "CREATE VIEW result_view AS SELECT table_chemp._id as table_chemp__id, table_chemp.title as table_chemp_title, table_result.balls as table_result_balls, table_result.chemp_id as table_result_chemp_id, table_result.games as table_result_games, table_result.goals as table_result_goals, table_result._id, table_result.lose as table_result_lose, table_result.points as table_result_points, table_result.team_id as table_result_team_id, table_result.tie as table_result_tie, table_result.wins as table_result_wins, table_team.chemp_id as table_team_chemp_id, table_team._id as table_team__id, table_team.is_fav as table_team_is_fav, table_team.title as table_team_title FROM result_table AS table_result JOIN chemp_table AS table_chemp ON table_chemp._id = table_result.chemp_id JOIN team_table AS table_team ON table_team._id = table_result.team_id"; public static void onCreate(final SQLiteDatabase db) { db.execSQL(SQL_CREATE_RESULT_TABLE); db.execSQL(SQL_CREATE_CHEMP_TABLE); db.execSQL(SQL_CREATE_TEAM_TABLE); db.execSQL(SQL_CREATE_SCORE_TABLE); db.execSQL(SQL_CREATE_CHEMP_INDEX); db.execSQL(SQL_CREATE_RESULT_VIEW); db.execSQL(SQL_CREATE_SCORE_VIEW); } public static void onDrop(final SQLiteDatabase db){ db.execSQL("drop table if exists result_table"); db.execSQL("drop table if exists chemp_table"); db.execSQL("drop table if exists team_table"); db.execSQL("drop table if exists score_table"); db.execSQL("drop view if exists result_view"); db.execSQL("drop view if exists score_view"); } } 

प्लेटों के विवरण से स्थिरांक के उपयोग की आवश्यकता नहीं है, क्योंकि फ़ाइल जनरेट की गई है और स्पष्ट रूप से इस प्रकार है कि आपने टेबल घोषणा में क्या लिखा है

SqlSchema का उपयोग करना

  private class AnnotationSql extends SQLiteOpenHelper { public AnnotationSql(Context context) { super(context, FStore.DB_NAME, null, FStore.DB_VERSION); } @Override public void onCreate(SQLiteDatabase db) { SqlSchema.onCreate(db); init(db); } @Override public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) { SqlSchema.onDrop(db); onCreate(db); } } 

योजनाओं

1. विभिन्न प्रकार के जोड़ लगाएं
2. केवल आवश्यक फ़ील्ड रेक में शामिल होने के लिए कॉलम एनोटेशन जोड़ें

संदर्भ

बायनेरिज़: github.com/hamsterksu/Android-AnnotatedSQL-binaries
स्रोत: github.com/hamsterksu/Android-AnnotatedSQL

लाइसेंस: MIT

आप सभी को धन्यवाद!

# 1 अद्यतन करें: स्कीमा को अद्यतन करने के बारे में

मैं OpenHelper उत्पन्न नहीं करता, आप इसे स्वयं लिखते हैं। इसलिए कोई भी जटिल तर्क लिखने के लिए परेशान नहीं करता है, और उत्पन्न स्क्रिप्ट ऑनक्रिएट के लिए काम करेगी।
OnUpgrad में, आप फ़ील्ड्स को बहुत ही सरलता से जोड़ / हटा / बदल सकते हैं - आपके पास तालिकाओं और फ़ील्ड के नाम हैं।
आरेख में, मैं सदस्यों को खुला कर दूंगा - फिर आप उन्हें एक्सेस कर सकते हैं और तालिकाओं को बदलने के बाद विचारों को फिर से बना सकते हैं