Kieran Dang - the cat seeking a new vision

2010-03-06

Zend Studio 5.5 on Windows 7

Original post http://melikedev.com/2009/11/28/zend-studio-5-5-on-windows-7/ . It is very helpful post, thank the author.

If you are reading this, then you have Windows 7 installed and gave Zend Studio 7.x the old college try, and found it to be quite cumbersome and annoying. After trying to adapt to Zend with Eclipse you opted to go back to Zend Studio 5.5 but found that it doesn’t work ‘out of the box’ on Windows 7. If you googled ‘Zend 5.5 Windows 7′ you probably found a response on Zend’s Forums where a savior post is located. At first read it is a bit confusing so I am going to attempt to make it a bit more clear here. Make no mistake, save for a few minor changes, the original author djvirgen (appended to by phliplip), are the true geniuses behind the work. You can find the original post @ http://www.zend.com/forums/index.php?t=msg&th=7855#21175

1. Download and install the latest JRE for Windows 7: http://java.com/en/download/manual.jsp

2. Download and install WinRAR (ensure you install with Explorer shell extension checked): http://rarlabs.com

3. Download Zend Studio 5.5.1 (you will need Zend account): http://www.zend.com/products/studio/downloads-prev

4. Extract Zend Studio 5.5.1

5. Click into ZendStudio-5_5_1 directory after extraction

6. Right mouse click on ZendStudio-5_5_1 executable, you will then see an option to ‘extract to (thanks to winrar shell extension), click it.

7. After Zend Studio 5.5.1 has been extracted click into ZendStudio-5_5_1/Windows/r

esource

8. You should see a dir named ‘jre’, rename this to ‘jre_came_with_zend’

9. Copy ‘jre6′ from your Java install directory (typically C:\Program Files (x86)\Java) into the Zend Studio extracted directory (ZendStudio-5_5_1\Windows\resource)

10. Rename ‘jre6′ to ‘jre’

11. Click up one dir so you are in ZendStudio-5_5_1/ and click on ZendStudio-5_5_1.exe

12. You will instantly know if you did not do the above steps correctly was windows 7 will inform you that you are attempting to run an app incompatible with Aero (this is because the jre packaged with zend is old, if so re-read above steps and try again)

13. If everything went fine, you should now be faced with a message “Java Runtime Environment Not Found.” Don’t worry about it, install zend as you normally would.

14. Zend Studio install should be finished, do not launch zend yet, we aren’t quite done.

15. Copy the ‘jre_came_with_zend’ directory from the original extraction folder and paste it into your Zend install directory (the one you selected during install, default is: c:\Program Files (x86)\Zend\ZendStudio-5.5.1

16. Rename the current ‘jre’ directory found in the Zend install directory to ‘jre_installed_with_zend’

17. Rename the ‘jre_came_with_zend’ to ‘jre’

18. Click into bin directory

19. Right mouse click ZDE.exe

20. Click properties

21. Click the compatibility tab

22. Click checkmark for ‘Compatibility Mode’ and select ‘Windows Vista’ from the dropdown menu

23. Click apply

24. Click ok

25. Now, with any luck you can double click on the ZDE.exe file and Zend should start normally.
Took a few hours to get all this down, hope this helps anyone else out there wanting to use Zend Studio 5.5.x vs the new Zend /w Eclipse crap. Good luck!

2010-02-26

Inversion of Control (IoC), Dependency Inversion Principle (DIP) và Dependency Injection (DI)

Inversion of Control (IoC), Dependency Inversion và Dependency Injection

Mục tiêu giới thiệu Inversion of Control (IoC), Dependency Inversion và mối liên quan giữa 2 khái niệm này với Dependency Injection.

Trên Wikipedia và trong series của Rich cũng không define chính xác IoC là gì. Inversion of Control ý muốn đề cập tới các software architecture designs có flow of control ngược với kiến trúc cũ dạng software libraries (traditional architecture of software libraries). Không có gì ghê gớm cả ... :D, cứ cố hiểu đơn giản vậy là được. Trên blog của Martin Flower cũng có một bài viết khá hay 'Inversion of Control Containers and the Dependency Injection pattern', nếu có thời gian thì bạn có thể tham khảo để biết quan điểm của một người chuyên nghiên cứu về software design.

Inversion of Control in Relation to Frameworks

IoC có quan hệ với framework và code re-used. Thông thường khi sử dụng lại code chúng ta thường call một library của ai đó. Ví dụ trong .NET khi gọi method Math.Tan tức là make a call và tức là có control method đó (đơn là hãy nghĩ rằng sử dụng được nó có nghĩ là control được nó).

Nhưng khi thực hiện implement một IComparable hay IEnumerable thì .NET framework sẽ call ngược lại code implement. Trong những trường hợp này thì direction of control bị đảo ngược: something else calling you. Ví dụ implement IComparable thì phải implement method CompareTo. Khi chúng ta gọi hàm Sort thì .NET framework gọi ngược lại method CompareTo mà chúng ta implement.

Inversion of Control và Dependency Injection

Hai khái niệm này thường được coi là đồng nghĩa tuy nhiên DI chỉ là một dạng đặc biệt mô tả cách thực hiện IoC tức IoC có một phạm vi lớn hơn DI.

Inversion of Control và CAB

CAB là một framework IoC và cho phép chúng ta thực hiện DI. Tức CAB có thể thực hiện call us chứ không hoàn toàn là một framework để chúng ta call method và sử dụng. Ví dụ như trong lab về module loader hàm Load() của ModuleInit đã được CAB thực hiện.

Dependency Inversion

Một term có liên quan và dễ gây bối rối là Dependency Inversion. Dependency Inversion còn gọi là Dependency Inversion Principle- DIP, là wider concept của Dependency Injection. DI chỉ là một phần trong DIP, DIP quy định cách thức mà một high-module cần thực hiện khi sử dụng một low-module. Inversion (đảo ngược) ở đây nằm ở chỗ high level thông thường dựa trên low level thì sẽ chuyển lại giở đây cả high level và low level depend upon một shared abstraction. Software consultant Robert C. Martin (tham khảo Agile Software Development, Principles, Patterns, and Practices published by Prentice Hall 10/15/2002 ISBN-10: 0135974445) phát biểu như sau:

High level modules should not depend upon low level modules. Both should depend upon abstractions. Abstractions should not depend upon details. Details should depend upon abstractions.

Đại khái là module cao hơn không nên phụ thuộc vào module bên dưới. Cả hai nên dựa vào một 'trừu tượng'. 'Trừu tượng' không được phụ thuộc vào 'chi tiết' mà 'chi tiết' sẽ phụ thuộc 'trừu tượng'.

DIP và IoC

Trong bài lab về DI chúng ta chỉ thực hiện invert dependent giữa các classes. Chúng ta chưa thấy IoC xuất hiện rõ ràng trong ví dụ đó. Nói chung chúng ta chưa cần đi quá sâu thay vì chỉ cần hiểu có thể làm được gì với CAB.

CAB & SCSF - Part 03: Dependency Injection

Dependency Injection

Tìm hiểu Dependency Injection ở phạm vi chung không phải Dependency Injection cụ thể cài đặt trong CAB. Mục tiêu hiểu khái quát về khái niệm Dependency Injection.

Giả sử class Car có đang có nhu cầu sử dụng class EngineA. Tuy nhiên có khả năng class Engine sẽ thay đổi trong tương lai hoặc có nhu cầu sử dụng nhiều kiểu Engine khác nhau. Nếu sử dụng thông qua một interface IEngine, khi chuyển qua sử dụng một loại Engine khác là EngineB sẽ không cần thực hiện modify lại code mà chỉ cần thực hiện config lại theo 1 cách nào đó.

Scenario thứ 2 là việc sử dụng engine theo kiểu service yêu cầu nhiều dependency services khác tạo thành một dependency graph. Do đó mỗi khi thực hiện tạo một instance của class Car rất mất công và bạn phải biết constructor hay builder của Engine.

var generator = new Generator();
var engine = new Engine(generator);
var car = new Car(engine);

Có thể thấy một chút giống Strategy Pattern chỉ khác Dependency Injection thiên về việc cấu hình để có thể chọn lựa được class sử dụng tại thời điểm run-time. Việc này có thể thực hiện bằng các ngôn ngữ hỗ trợ reflection. Có 3 loại Dependency Injection là thực hiện qua setter injection, constructor injection và interface injection. Việc thực hiện DI còn liên quan đến 1 việc gọi là service locator. Nhiệm vụ của service locator là xác định đúng engine cần dùng thông qua GetCorrectEngine method. Thông thường một class giả sử tên là EngineLocator sẽ thực hiện nhiệm vụ này.

Constructor method

public interface IEngine
{
    void Start();
}

public class Engine : IEngine
{
    public void Start();
}

public class Car
{
    protected IEngine engine;

    public Car(IEngine engine)
    {
        this.engine = engine;
    }
}

Setter method

public class Car
{
    protected IEngine engine;

    public IEngine Engine
    {
        set
        {
            engine = value;
        }
    }
}

Interface method

public interface IInjectEngine
{
    void InjectEngine(IEngine engine);
}

public class Car: IInjectEngine
{
    protected IEngine engine;

    void IInjectEngine.InjectEngine(IEngine engine)
    {
        this.engine = engine;
    }
}

Thông thường việc thực hiện sẽ dùng hướng interface injection. Đến đây nếu chưa hiểu rõ DI chắc chắn bạn vẫn chưa hình dung được việc tách biệt interface và implement là có ý nghĩa như thế nào và tại sao Car không cần thiết phải chỉnh sửa mà chỉ cần chỉnh sửa thông qua file config.

Implementation

Lập một solution tên là Part03A với các project như sau:

Car: console application, có một file là Car.cs, assembly name là ConsoleApp, output ConsoleApp.exe.
EngineA: library project, chứa EngineA.cs, assembly EngineA.
EngineB: library project, chứa EngineB.cs, assembly EngineB.
IEngine: library project, chứa định nghĩa interface.

- Để đơn giản các project đang sử dụng cùng một namespace là DI. Cấu hình Assembly name và default namespace trong Properties của project.

- Bước tiếp theo cấu hình Output của các project giả sử là '..\bin\Debug' mục đích các file IEngine.dll, EngineA.dll và EngineB.dll sẽ cùng thư mục với ConsoleApp.exe (vì các projects này không reference đến nhau)

- Thêm vào Car project một application config file App.config. Add reference tới IEngine cho 3 project còn lại. Việc này có nghĩa Car không có reference tới bất kỳ cài đặt nào của Engine: EngineA hoặc EngineB. Việc này cho phép luôn luôn build OK với Car cho dù có hay không có EngineA và EngineB, do đó việc develop Car là hoàn toàn độc lập với Engine.

Thực hiện code của các file như sau:

IEngine.cs

namespace DI
{
    public interface IEngine
    {
        void Start();
    }
}

IInjectEngine.cs

namespace DI
{
    public interface IInjectEngine
    {
        void InjectEngine(IEngine engine);
    }
}

EngineA.cs và EngineB.cs

public class EngineA : IEngine
{

    public void Start()
    {
        Console.WriteLine("Engine A start...")
    }
}

public class EngineB : IEngine
{

    public void Start()
    {
        Console.WriteLine("Engine B start...")
    }
}

Car.cs

namespace DI
{
    public class Car : IInjectEngine
    {
        IEngine engine;

        public void Start()
        {
            engine.Start();
        }

        public void InjectEngine(IEngine engine)
        {
            this.engine = engine;
        }
    }
}

Program.cs

namespace DI
{
    class Program
    {
        static void Main(string[] args)
        {
            // Create our car and inject the dependency
            Car car = new Car();

            // Service locator, get the correct address based on configuration file
            IEngine engine = GetCorrectEngine();
            ((IInjectCar)car).InjectEngine(engine);

            // Use the car, the method references the car
            // so behavior depends on the configuration file
            car.Start();
            Console.ReadLine();
        }

        // Instantiate and return a class conforming to the IEngine interface:
        // which class gets instantiated depends on the ClassName setting in
        // the configuration file
        static IEngine GetCorrectEngine()
        {
            string className = System.Configuration.ConfigurationSettings.AppSettings["ClassName"];
            Type type = System.Type.GetType(className);
            return (IEngine)Activator.CreateInstance(type);
        }
    }
}

- Method GetCorrectEngine đọc file config và tạo một instance của Engine đúng với implement cần chỉ định thông qua reflection.

- Nếu nội dung file config App.config không đúng (không có key ClassName) việc build vẫn OK tuy nhiên sẽ gặp run-time error vì không tạo được object. Cần phải chỉ định assembly name.

xml version="1.0" encoding="utf-8" ?>
<configuration>
  <appSettings>
    <add key="ClassName" value="DI.EngineA" />
  </appSettings>
</configuration>

- Chỉnh lại file config tốt nhất là dùng AssemblyQualifiedName hoặc đơn giản chỉ cần dùng "DI.EngineA, EngineA"

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
  <appSettings>
    <add key="ClassName" value="DI.EngineA, EngineA, Version=1.0.0.0, Culture=neutral, PublicKey Token=null" />
  </appSettings>
</configuration>

- Thực hiện thay đổi file config dùng EngineB và run lại application, nhận xét và rút ra kết luận.

2010-01-17

CAB & SCSF - Part 02: WorkItems

-->

WorkItems

Part 2: Overview khái niệm WorkItem.

WorkItems – Basic Concepts

Theo tài liệu của Microsoft mô tả là một run-time container chứa các component hợp tác với nhau thực hiện chức năng của một use case (a run-time container of components that are collaborating to fulfill a use case). Có thể xem WorkItems là các class trong đó có chứa các collection của các class khác. WorkItem trích từ metadata như sau:

using Microsoft.Practices.CompositeUI.Collections;

using Microsoft.Practices.CompositeUI.Commands;

using Microsoft.Practices.CompositeUI.EventBroker;

using Microsoft.Practices.CompositeUI.SmartParts;

using Microsoft.Practices.CompositeUI.Utility;

using Microsoft.Practices.ObjectBuilder;

using System;

using System.ComponentModel;

using System.Diagnostics;

namespace Microsoft.Practices.CompositeUI

{

public class WorkItem : IBuilderAware, IDisposable

{

public WorkItem();

public ManagedObjectCollection<Command> Commands { get; }

public ManagedObjectCollection<EventTopic> EventTopics { get; }

public string ID { get; set; }

protected Builder InnerBuilder { get; }

protected IReadWriteLocator InnerLocator { get; }

public ManagedObjectCollection<object> Items { get; }

[Dependency(NotPresentBehavior = NotPresentBehavior.ReturnNull)]

[Browsable(false)]

public WorkItem Parent { get; set; }

[Browsable(false)]

public WorkItem RootWorkItem { get; }

public ServiceCollection Services { get; }

public ManagedObjectCollection<object> SmartParts { get; }

public State State { get; }

public WorkItemStatus Status { get; }

public TraceSource TraceSource { set; }

public UIExtensionSiteCollection UIExtensionSites { get; }

public ManagedObjectCollection<WorkItem> WorkItems { get; }

public ManagedObjectCollection<IWorkspace> Workspaces { get; }

public event EventHandler Activated;

public event CancelEventHandler Activating;

public event EventHandler Deactivated;

public event CancelEventHandler Deactivating;

public event EventHandler Disposed;

public event EventHandler<DataEventArgs<string>> IdChanged;

public event EventHandler Initialized;

public event EventHandler RunStarted;

public event EventHandler Terminated;

public event EventHandler Terminating;

public void Activate();

protected internal void BuildUp();

protected virtual Command CreateCommand(Type t, string name);

protected virtual EventTopic CreateEventTopic(Type t, string topicName);

public void Deactivate();

public void DeleteState();

public void Dispose();

protected virtual void Dispose(bool disposing);

protected internal void FinishInitialization();

public TSmartPartInfo GetSmartPartInfo<TSmartPartInfo>(object smartPart) where TSmartPartInfo : ISmartPartInfo;

protected internal void InitializeRootWorkItem(Builder builder);

protected virtual void InitializeServices();

[InjectionMethod]

public void InitializeWorkItem();

public void Load();

protected virtual void OnActivated();

protected virtual void OnActivating(CancelEventArgs args);

public virtual void OnBuiltUp(string id);

protected virtual void OnDeactivated();

protected virtual void OnDeactivating(CancelEventArgs args);

protected virtual void OnDisposed();

protected virtual void OnIdChanged();

protected virtual void OnInitialized();

protected virtual void OnObjectAdded(object item);

protected virtual void OnObjectRemoved(object item);

protected virtual void OnRunStarted();

public virtual void OnTearingDown();

protected virtual void OnTerminated();

protected virtual void OnTerminating();

public void RegisterSmartPartInfo(object smartPart, ISmartPartInfo info);

public void Run();

public void Save();

public void Terminate();

}

Dễ dàng nhận thấy WorkItem có các 3 collection như sau:

1. Items là một collection loại object nên có thể contains tất cả mọi thứ.

2. Services collection chứa các CAB services (sẽ đề cập sau)

3. WorkItems collection là một collection base trên WorkItem. Đây là các child WorkItems. Collection này thể hiện Composite pattern mà chúng ta đã tìm hiểu.

4. Các collection khác SmartParts, UIExtensionSites, Workspaces.

WorkItem còn có State để theo dõi sự thay đổi trạng thái implement ISerializable và Status chỉ định là active hay inactive.

Theo mô tả ở trên sẽ thấy có rất nhiều thuật ngữ chưa đề cập và các thuật ngữ này rất mới và khó hiểu.

Container Hierarchy và Root WorkItem

Các WorkItems có thể biểu diễn dưới dạng phân cấp. Theo như lab 1 thì program có một RootWorkItem và Shell là một instance của ShellForm. Blue module và Red module sẽ được load vào RootWorkItem. WorkItem child có thể được truy cập qua code dạng như sau:

this.WorkItem.WorkItems["SpecificName"]

Đến đây chúng ta có thể mơ hồ nhận ra mối quan hệ giữa CAB và Composite pattern mà chúng ta đã tìm hiểu.

WorkItems và FormShellApplication

Ví dụ như trong lab về module loader của Part 1, Program chứa top-root WorkItem và được truy cập thông qua code:

this.RootWorkItem

Program cũng chứa một Shell có thể truy cập qua code:

this.Shell

Notes: hiện tại lab module loader Part 1 vẫn chưa thực hiện dùng hay truy cập thông qua các properties này. Các bài labs tiếp theo sẽ thực hiện trên các property này.

Trong phần tiếp theo chúng ta sẽ tìm hiểu cách thực hiện việc load modules cụ thể như thế nào. Đối tượng để tìm hiểu là Dependency Injection, một khái niệm quan trọng.

CAB & SCSF - Part 01: Module loader

-->

Module Loader

Part 1: giới thiệu tính năng module loader của CAB

Chuẩn bị lab về module loader

Mục đích giới thiệu tính năng tìm và load module qua ProfileCatalog.xml

- Bước chuẩn bị, tạo solution Part01A.sln có các project như sau:

Project	Type/Desc
Blue	Form application, có một form là BlueForm back color là màu xanh. Assembly name là Blue, namespace là Blue.
Red	Form application, có một form là RedForm back color màu đỏ. Assembly name là Red, namespace là Red.
Shell	Một form application default. Assembly name là Shell, namespace là Shell.

- Nếu chúng ta đã thực hiện cài đặt Composite UI Application Block thì thư mục mặc định sẽ nằm tại C:\Program Files\Microsoft Composite UI App Block với C là system drive. Chúng ta sẽ thực hiện import các project CAB nằm trong C:\Program Files\Microsoft Composite UI App Block\CSharp\Source\CompositeUI vào solution. Nếu sử dụng Visual Studio 2008 chúng ta cần convert các project này theo thứ tự từ ObjectBuilder trước. Tuy nhiên để đơn giản chỉ cần DLL files, tạo thư mục ThirdParty cùng cấp với thư mục chứa solution Part01A, copy vào đó 3 files sau:

Microsoft.Practices.CompositeUI.dll

Microsoft.Practices.CompositeUI.WinForms.dll

Microsoft.Practices.ObjectBuilder.dll

- Tạo solution folder ThirdParty: thay vì import các project của CAB chúng ta thực hiện import 3 DLL files đã nói ở trên.

Cấu trúc thư mục

- Add reference tới 3 files trong ThirdParty cho các project Red, Blue và Shell

Các khái niệm:

Module: đơn giản có thể coi là một ‘component’ hay một ‘application’. Là một block of code thông thường là một UI có thể hiển thị trên một window thường nhưng không reference tới một module khác. Có thể tưởng tượng module là project trong .NET solution. Tổng kết là một standalone project trong đó có một composite user interface.

Shell: một host form chứa các composite user interface.

Nội dung của module - Tìm hiểu ModuleInit

- Thêm vào trong mỗi solution một file như sau (BlueModuleInit.cs):

using Microsoft.Practices.CompositeUI;

namespace Blue

{

public class BlueModuleInit : ModuleInit

{

public override void Load()

{

base.Load();

BlueForm form = new BlueForm();

form.Show();

}

- Chúng ta thấy BlueModuleInit kế thừa từ ModuleInit (from metadata):

using System;

namespace Microsoft.Practices.CompositeUI

{

public abstract class ModuleInit : IModule

{

protected ModuleInit();

public virtual void AddServices();

public virtual void Load();

}

- Trong ModuleInit khai báo 2 method là AddService và Load. Hiện tại file BlueModuleInit chỉ thực hiện override method Load tạo một BlueForm và thực hiện show form này.

Thực hiện tương tự với Red project.

- Trong Shell project add thêm 1 file xml ProfileCatalog.xml tên nội dung như sau:

xml version="1.0" encoding="utf-8" ?>

Modules>

SolutionProfile>

- ProfileCatalog mô tả các module sẽ thực hiện tìm và load khi application của Shell project thi hành.

- Thực hiện modify Program.cs của project Shell. Nội dung như sau:

using System;

using System.Collections.Generic;

using System.Windows.Forms;

using Microsoft.Practices.CompositeUI.WinForms;

using Microsoft.Practices.CompositeUI;

namespace Shell

{

public class Program : FormShellApplication<WorkItem, ShellForm>

{

///

/// The main entry point for the application.

///

[STAThread]

static void Main()

{

new Program().Run();

}

- Thực hiện modify lại theo các bước bỏ modifier static, thêm kế thừa từ FormShellApplication.

Notes: reference ‘static classes [C#]’ trong MSDN

Static classes and class members are used to create data and functions that can be accessed without creating an instance of the class. Static class members can be used to separate data and behavior that is independent of any object identity: the data and functions do not change regardless of what happens to the object. Static classes can be used when there is no data or behavior in the class that depends on object identity.

- FormShellApplication là một abstract class với generics parameterize TWorkItem là một CompositeUI.WorkItem và TShell là một Windows Form

using System;

namespace Microsoft.Practices.CompositeUI.WinForms

{

public abstract class FormShellApplication<TWorkItem, TShell> : WindowsFormsApplication<TWorkItem, TShell>

where TWorkItem : Microsoft.Practices.CompositeUI.WorkItem, new()

where TShell : System.Windows.Forms.Form

{

protected FormShellApplication();

protected override void Start();

}

Note: reference ‘generics [C#]’ trong MSDN:

Generics were added to version 2.0 of the C# language and the common language runtime (CLR). Generics introduce to the .NET Framework the concept of type parameters, which make it possible to design classes and methods that defer the specification of one or more types until the class or method is declared and instantiated by client code.

- Thực hiện build và run Shell vẫn không thấy có chuyện gì xảy ra. Vẫn chỉ có một form Shell hiện lên. Lý do: trong ‘\Shell\bin\Debug’ vẫn chưa có file ProfileCatalog.xml. Chỉnh lại property ‘Copy to Output Directory’ của ProfileCatalog thành ‘Copy Always’.

- Thực hiện build và run lại project sẽ xuất hiện exception như sau:

Lý do là không tìm được Red.exe trong ‘\Shell\bin\Debug\Blue.exe was not found.’

Thực hiện chỉnh lại ‘Output Path’ của các project Red và Blue thành ‘..\Shell\bin\Debug\’ để 3 project cùng output folder.

- Thực hiện rebuild các solution sẽ thấy kết quả là Shell load cả Red và Blue lên. Để thực hiện được điều này mặc định module loader của CAB đã sử dụng thông tin trong ProfileCatalog. Khi thực hiện close shell thì cả Red form và Blue form cũng sẽ close theo.

- Nếu tách riêng thì từng project vẫn có thể chạy độc lập với nhau. Trong trường hợp mỗi người thực hiện develop trên một project thì kết quả khi chạy shell sẽ là tổng hợp công việc của 3 developers. Tới đây chúng ta có thể hiểu phần nào ý tưởng của CAB.

Trong phần tiếp theo chúng ta sẽ đề cập đến WorkItem. Một khái niệm căn bản trong CAB.