Приветы.
Так как я ни разу не работал, ибо студент, и не знаю как реализуются реальные проекты у меня возник вопрос, к тем людям которые
представляют как должно быть на самом деле. Довольно тривиальная задача, уровня лабораторной работы. Хочу сделать ее идеально, так как бы сделал гуру. С одной стороны не должно быть портянок на которые пришлось бы тратить уйму времени для сопровождения, с другой не должно быть оверинженеринга, в общем все по уму.
Приложение - примитивный журнал документов. Входящие\исходящие, откуда и когда пришли краткое содержание etc
Итак, суть. Использую firebird + winforms.
Модель данных БД(2 таблицы):
1. T_DOC_TYPE //Типы документов
F_ID(PK) //ID
,F_NAME //Наименование
,F_DAY_TO_PERFORM //Дней до исполнения
,F_TO_ALARM //Дней до предупреждения
2. T_DOC //Документы
F_ID //ID
,F_DOC_TYPE(FK->T_DOCTYPE) //Тип документа
,остальные реквизиты документа
Хранимок и вьюх нет, есть по одному триггеру на таблицу для получения ID из сиквенса
С описанием БД закончил, теперь к приложеню)
Скрин главного окна для наглядности:
В меню справочники мы проваливаемся в окно для редактирования типов документов:
Есть еще одно маленькое окно для добавляения\редактирования типа документов в грид и в БД соответственно, потому что редактируемые гриды в приложении кажутся мне не кошерными
Теперь к коду
В коде форм ничего нету, кроме создания компоненов и обработчиков событий которые дергают все остальное в одну строчку
Есть 4 класса:
BindingINI, для чтения .ini файла в котором прописаны пути к БД и пути к шаблону отчетов .xls
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.
17.
18.
19.
20.
21.
22.
23.
24.
25.
26.
27.
28.
29.
namespace DocRegister
{
public class BindingINI
{
/*
* Чтение .ini файла
* Параметры:
* (key) ключ в .ini файле
* Возвращает:
* (string) значениe ключа key
* (null) если ключа key нет
*/
public static string readSetting(string key)
{
string line;
StreamReader srFile = new StreamReader(@"DRConfig.ini");
while ((line = srFile.ReadLine()) != null)
{
if (line.Contains(key))
{
srFile.Close();
return line.Substring(key.Length);
}
}
srFile.Close();
return line;
}
}
}
BindingDB, для подключения к БД и работе с ней
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.
17.
18.
19.
20.
21.
22.
23.
24.
25.
26.
27.
28.
29.
30.
31.
32.
33.
34.
35.
36.
37.
38.
39.
40.
41.
42.
43.
44.
45.
46.
47.
48.
49.
50.
51.
52.
53.
54.
55.
56.
57.
58.
59.
60.
61.
62.
63.
64.
65.
66.
67.
68.
69.
70.
71.
72.
73.
74.
75.
76.
77.
78.
79.
80.
81.
82.
83.
84.
85.
86.
87.
88.
89.
90.
91.
92.
93.
94.
95.
96.
97.
98.
99.
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.
namespace DocRegister
{
public class BindingDB
{
/*
* Создание строки подключения с БД
* Возвращает:
* (string) строка подключения
*/
private static string GetConString()
{
FbConnectionStringBuilder ConString = new FbConnectionStringBuilder();
ConString.UserID = "SYSDBA";
ConString.Password = "masterkey";
ConString.Database = BindingINI.readSetting("DataBasePatch=");
ConString.ServerType = 0;
return ConString.ToString();
}
/*
* Создание соединения с БД
* Возвращает:
* (Connection) соединение с БД
* (null) если строка подключения невалидна
*/
private static FbConnection GetConnection()
{
try
{
return new FbConnection(GetConString());
} catch (System.ArgumentException exp)
{
MessageBox.Show(exp.ToString(),
"Ошибка соединения с БД",
MessageBoxButtons.OK,
MessageBoxIcon.Error);
return null;
}
}
/*
* Получение данных из БД
* Параметры:
* (query) SQL запрос к БД
* Возвращает:
* (DataTable) результирующую таблицу SQL запроса
* (null) если не удалось подключится к БД или SQL запрос с ошибкой
*/
public static DataTable GetTable(string query)
{
FbConnection connection = GetConnection();
if (connection == null)
return null;
FbDataAdapter dAdapter = new FbDataAdapter(query, connection);
DataSet dSet = new DataSet();
try
{
dAdapter.Fill(dSet);
return dSet.Tables[0];
}
catch (FbException exp)
{
MessageBox.Show(exp.ToString(),
"Ошибка соединения с БД",
MessageBoxButtons.OK,
MessageBoxIcon.Error);
return null;
}
}
/*
* Добавление\Изменение\Удаление данных из БД
* Параметры:
* (query) SQL запрос к БД
* Возвращает:
* (string) параметр из запроса
* (string) "success" если запрос был без параметра
* (null) если не удалось подключится к БД или SQL запрос с ошибкой
*/
public static string SetTable(string query)
{
FbConnection connection = GetConnection();
if (connection == null)
return null;
try
{
FbCommand command = new FbCommand(query, connection);
FbParameter parameter = new FbParameter();
parameter.Direction = ParameterDirection.Output;
FbParameter parameter1 = new FbParameter();
parameter1.Direction = ParameterDirection.Output;
command.Parameters.Add(parameter);
connection.Open();
command.ExecuteNonQuery();
connection.Close();
if (command.Parameters[0].Value == null)
return "success";
return command.Parameters[0].Value.ToString();
}
catch (FbException exp)
{
connection.Close();
MessageBox.Show(exp.ToString(),
"Ошибка соединения с БД",
MessageBoxButtons.OK,
MessageBoxIcon.Error);
return null;
}
}
/*
* Создает резервную копию БД
* с наименованием в формате "dd.MM.yyyy.HH.mm.ss"
* в директории с БД
*/
public static void CreateBackup()
{
string patchNameBackup = BindingINI.readSetting("DataBasePatch=");
string patchBackup = patchNameBackup.Substring(0, patchNameBackup.LastIndexOf(@"\") + 1);
string nameBackup = System.DateTime.Now.ToString("dd.MM.yyyy.HH.mm.ss");
try
{
FbBackup backup = new FbBackup { ConnectionString = GetConString() };
backup.BackupFiles.Add(new FbBackupFile(patchBackup + nameBackup + ".gbk", 2048));
backup.Verbose = true;
backup.Options = FbBackupFlags.IgnoreLimbo;
backup.Execute();
}
catch (FbException exp)
{
MessageBox.Show(exp.ToString(),
"Ошибка соединения с БД",
MessageBoxButtons.OK,
MessageBoxIcon.Error);
}
}
}
}
DocType, класс Тип документа, имеет методы добавления, изменения, удаления, работает с классом BindingDB
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.
17.
18.
19.
20.
21.
22.
23.
24.
25.
26.
27.
28.
29.
30.
31.
32.
33.
34.
35.
36.
37.
38.
39.
40.
41.
42.
43.
44.
45.
46.
47.
48.
49.
50.
51.
52.
53.
54.
55.
56.
57.
58.
59.
60.
61.
62.
63.
64.
65.
66.
67.
68.
69.
70.
71.
72.
73.
74.
75.
76.
77.
78.
79.
80.
81.
82.
83.
84.
85.
86.
87.
88.
89.
90.
91.
92.
namespace DocRegister
{
public class DocumentType
{
private SqlInt32 docTypeID; //ID вида документа
private SqlString name; //Наименование
private SqlInt32 dayToPerform; //Дней на исполнение
private SqlInt32 dayToAlarm; //Дней до предупреждения
/*
* Инициализирует новый тип документа
*/
public DocumentType(SqlString Name, SqlInt32 DayToPerform, SqlInt32 DayToAlarm)
{
this.name = Name;
this.dayToPerform = DayToPerform;
this.dayToAlarm = DayToAlarm;
}
/*
* Инициализирует уже существующий тип документа
*/
public DocumentType(SqlInt32 DocTypeID, SqlString Name, SqlInt32 DayToPerform, SqlInt32 DayToAlarm)
{
this.docTypeID = DocTypeID;
this.name = Name;
this.dayToPerform = DayToPerform;
this.dayToAlarm = DayToAlarm;
}
/*
* Удаляет тип документа из БД
*/
public void Delete()
{
BindingDB.SetTable("DELETE\n" +
"FROM T_DOC_TYPE\n" +
"WHERE F_ID = " + this.docTypeID.Value);
}
/*
* Обновляет тип документа в БД
*/
public void Update()
{
BindingDB.SetTable("UPDATE T_DOC_TYPE\n" +
"SET F_NAME = '" + this.name.Value + "'\n" +
" ,F_DAY_TO_PERFORM = " + this.dayToPerform.Value + "\n" +
" ,F_DAY_TO_ALARM = " + this.dayToAlarm.Value + "\n" +
"WHERE F_ID = " + this.docTypeID.Value);
}
/*
* Добавляет тип документа в БД
*/
public void Insert()
{
this.docTypeID = SqlInt32.Parse(BindingDB.SetTable("INSERT INTO T_DOC_TYPE (F_NAME\n" +
" ,F_DAY_TO_PERFORM\n" +
" ,F_DAY_TO_ALARM)\n" +
"VALUES\n" +
"('" + this.name.Value + "'\n" +
"," + this.dayToPerform.Value + "\n" +
"," + this.dayToAlarm.Value + ")\n" +
"RETURNING F_ID"));
}
public SqlInt32 DocTypeID
{
get { return docTypeID; }
}
public SqlString Name
{
get { return name; }
set { name = value; }
}
public SqlInt32 DayToPerform
{
get { return dayToPerform; }
set { dayToPerform = value; }
}
public SqlInt32 DayToAlarm
{
get { return dayToAlarm; }
set { dayToAlarm = value; }
}
}
}
DocTypeCollection, класс Коллекция типов документа, имеет методы добавления, изменения, удаления, работает с классом DocType
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.
17.
18.
19.
20.
21.
22.
23.
24.
25.
26.
27.
28.
29.
30.
31.
32.
33.
34.
35.
36.
37.
38.
39.
40.
41.
42.
43.
44.
45.
46.
47.
48.
49.
50.
51.
52.
53.
54.
55.
56.
57.
58.
59.
60.
61.
62.
63.
64.
65.
66.
67.
68.
69.
70.
71.
72.
73.
74.
75.
76.
77.
78.
79.
80.
81.
82.
83.
84.
85.
86.
87.
88.
89.
90.
91.
92.
93.
94.
95.
96.
namespace DocRegister
{
public class DocTypeCollection
{
private BindingList<DocumentType> docTypes; //Коллекция типов документов
public BindingList<DocumentType> DocTypes
{
get { return docTypes; }
}
/*
* Инициализирует коллекцию типов документов
* запрос к БД, выборка всех типов
*/
public DocTypeCollection()
{
docTypes = new BindingList<DocumentType>();
DataTable table = BindingDB.GetTable("Select F_ID\n" +
" ,F_NAME\n" +
" ,F_DAY_TO_PERFORM\n" +
" ,F_DAY_TO_ALARM\n" +
"From T_DOC_TYPE");
foreach (DataRow dr in table.Rows)
{
this.docTypes.Add(new DocumentType((SqlInt32)((int)dr.ItemArray[0]),
(SqlString)((string)dr.ItemArray[1]),
(SqlInt32)((int)dr.ItemArray[2]),
(SqlInt32)((int)dr.ItemArray[3])));
}
}
/*
* Поиск типа документа в коллекции
* Параметры:
* (docTypeID) ID типа документа
* Возвращает:
* (DocumentType) ссылку на найденный тип документа
* (null) если тип документа не найден
*/
public DocumentType SearchDocType(SqlInt32 DocTypeID)
{
IEnumerable<DocumentType> ie = from dt in DocTypes
where dt.DocTypeID.Equals(DocTypeID)
select dt;
List<DocumentType> l = new List<DocumentType>(ie);
if (l.Count == 0)
return null;
return l[0];
}
/*
* Удаляет тип документа из БД затем из коллекции
* Параметры:
* (docTypeID) ID типа документа
*/
public void DeleteDocType(SqlInt32 DocTypeID)
{
DocumentType foundDT = SearchDocType(DocTypeID);
foundDT.Delete();
docTypes.Remove(foundDT);
}
/*
* Обновляет тип документа в коллекции затем в БД
* Параметры:
* (docTypeID) ID типа документа
* (Name) новое наименование
* (DayToPerform) новое кол-во дней на исполнение
* (DayToAlarm) новое кол-во дней до предупреждения
*/
public void UpdateDocType(SqlInt32 DocTypeID, SqlString Name, SqlInt32 DayToPerform, SqlInt32 DayToAlarm)
{
DocumentType foundDT = SearchDocType(DocTypeID);
foundDT.Name = Name;
foundDT.DayToPerform = DayToPerform;
foundDT.DayToAlarm = DayToAlarm;
foundDT.Update();
}
/*
* Добавляет новый тип документа в БД затем в коллекцию
* Параметры:
* (Name) Наименование типа документа
* (DayToPerfrom) Дней на исполнение документа
* (DayToAlarm) Дней до предупреждения
*/
public void InsertDocType(SqlString Name, SqlInt32 DayToPerform, SqlInt32 DayToAlarm)
{
DocumentType newDocType = new DocumentType(Name, DayToPerform, DayToAlarm);
newDocType.Insert();
docTypes.Add(newDocType);
}
}
}
Приложение пока что работает только с таблицей типов документов, но работа с самими документами я думаю будет аналогичной.
При запуске приложения и создании главной формы создается объект DocTypeCollection и загружает в себя все данные которые есть, далее по формам ходит только ссылка на объект DocTypeCollection и дергает методы !!!мне кажется это узким местом программы, потому что если второй пользователь запустит еще одни экземпляр приложения и будет редактировать типы документов, первый пользователь не увидит изменений т.к. загружает все типы документов лишь при создании приложения и хранит их в ОЗУ
Если у вас будет время вникнуть в суть моей писанины и высказать мнение я буду признателен. Отвечу на любой вопрос заинтересовавшихся если что-то не расписал.
